Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(BREAKING CHANGE) RTC 536910 - [source] Remove ubuntuAptSource INBM configuration tag and underlying code; replaced with source command #472

Merged
merged 18 commits into from
Feb 1, 2024

Conversation

tsirlapu
Copy link
Contributor

RTC 536910

Remove the UbuntuAptSource XML tag from the intel_manageability.conf file and its associated tag with it

The PR review is to check for sustainability and correctness. Sustainability is actually more business critical as correctness is largely tested into the code over time. Its useful to keep in mind that SW often outlives the HW it was written for and engineers move from job to job so it is critical that code developed for Intel be supportable across many years. It is up to the submitter and reviewer to look at the code from a perspective of what if we have to debug this 3 years from now after the author is no longer available and defect databases have been lost. Yes, that happens all the time when we are working with time scales of more than 2 years. When reviewing your code it is important to look at it from this perspective.

Author Mandatory (to be filled by PR Author/Submitter)

  • Developer who submits the Pull Request for merge is required to mark the checklist below as applicable for the PR changes submitted.
  • Those checklist items which are not marked are considered as not applicable for the PR change.
  • Items marked with an asterisk suffix are mandatory items to check and if not marked will be treated as non-compliant pull requests by the developers for Inner Source Development Model (ISDM) compliance

PULL DESCRIPTION

Provide a 1-2 line brief overview of the changes submitted through the Pull Request...

REFERENCES

Reference URL for issue tracking (JIRA/HSD/Github): <URL to be filled>

  • Added label to the Pull Request following the template: ISDM_<Complexity>*
    Note-1: Depending on complexity of code changes, use the suitable word for complexity: Low/Medium/High
    Example: PR for Slim boot loader project with medium complexity can have the label as: ISDM_Medium
  • Added label to the Pull Request for easier discoverability and search
  • RTC or HSD number will be included in final merge. HSD must always be included if available.
  • Changelogs are updated (or N/A if not customer visible)
  • inbm/log_changes.txt and inbm-vision/log_changes.txt are updated for potentially Validation-breaking log changes (or N/A if none)

CODE MAINTAINABILITY

  • Commit Message meets guidelines as indicated in the URL*
  • Every commit is a single defect fix and does not mix feature addition or changes*
  • Added required new tests relevant to the changes
    • PR contains URL links to functional tests executed with the new tests
  • Updated Documentation as relevant to the changes
  • Updated Build steps/commands changes as relevant
  • PR change contains code related to security
  • PR introduces changes that breaks compatibility with other modules (If YES, please provide description)
  • Specific instructions or information for code reviewers (If any):
  • Run 'go fmt' or format-python.sh as applicable.
  • New/modified methods and functions should have type annotations on signatures as applicable
  • New/modified methods must have appropriate doc strings (language dependent)

APPLICATION SPECIFIC

  • Does PR change default config files under /etc? If so, will application still work after an upgrade that leaves /etc alone, like a Mender upgrade?
  • Is cloud UI changed? If so, are cloud definition files updated?

Maintainer Mandatory (to be filled by PR Reviewer/Approving Maintainer)

  • Maintainer who approves the Pull Request for merge is required to mark the checklist below as appropriate for the PR change reviewed as key proof of attestation indicating reasons for merge.
  • Those checklist items which are not marked are considered as not applicable for the PR change.
  • Items marked with an asterisk suffix are mandatory items to check and if not marked will be treated as non-compliant pull requests by the maintainers for ISDM compliance.

QUALITY CHECKS

  • Architectural and Design Fit
  • Quality of code (At least one should be checked as applicable)*
    • Commit Message meets guidelines
    • PR changes adhere to industry practices and standards
    • Error and exception code paths implemented correctly
    • Code reviewed for domain or language specific anti-patterns
    • Code is adequately commented
    • Code copyright is correct
    • Confusing logic is explained in comments
    • Commit comment can be used to design a new test case for the changes
  • Test coverage shows adequate coverage with required CI functional tests pass on all supported platforms*
  • Static code scan report shows zero critical issues*
  • Integration tests are passing

CODE REVIEW IMPACT

  • Summary of Defects Detected in Code Review: <%P1xx,P2xx,P3xx,P4xx%>
    Note P1/P2/P3/P4 denotes severity of defects found (Showstopper/High/Medium/Low) and xx denotes number of defects found

SECURITY CHECKS

Please check if your PR fulfills the following requirements:

  • Follow best practices when handling primitive data types
  • Configure minimal permissions when opening pipes and ports
  • Check contents within input structures are valid before use
  • All forms of input validated
  • Avoid inter-process race conditions
  • Error and exception handling implemented
  • Defend against Canonical Representation Issues - Any paths utilized?
  • Follow 'secure by default' - Any configuration values added
  • Fail safe - Any failure scenarios?
  • Clean up temporary files - Any temporary files being used?

Code must act as a teacher for future developers

RTC 536910

Remove the UbuntuAptSource XML tag from the intel_manageability.conf file and its associated tag with it
@tsirlapu
Copy link
Contributor Author

/review

@nex-maximus
Copy link
Collaborator

Code Review Analysis

  • 🎯 Main theme: The PR removes the ubuntuAptSource configuration tag and associated code across various files in the project.
  • 📝 PR summary: This PR aims to clean up the codebase by removing the ubuntuAptSource XML tag and its related code from the configuration files, documentation, and Python scripts. The tag is no longer used in the project, and its removal is part of a cleanup effort to ensure the codebase remains maintainable and sustainable.
  • 📌 Type of PR: Refactoring
  • 🏅 Score: 85
  • 🧪 Relevant tests added: No
  • ⏱️ Estimated effort to review [1-5]: 2, because the PR is straightforward, involving the removal of a specific tag and its related code across multiple files. The changes are repetitive and do not involve complex logic.
  • 🔒 Security concerns: No

Code Review Feedback

💡 General suggestions: The PR successfully removes the ubuntuAptSource tag and associated code, which is a good practice for maintaining a clean and sustainable codebase. It is important to ensure that all references to the removed code are also cleaned up to prevent any potential issues in the future. Additionally, it would be beneficial to verify that the removal of this tag does not affect any other parts of the system that may have depended on it indirectly.

✨ Usage tips:

Tag me in a comment '@nex-maximus' and add one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."

inbm/dispatcher-agent/dispatcher/sota/setup_helper.py Outdated Show resolved Hide resolved
docs/Configuration Parameters.md Outdated Show resolved Hide resolved
docs/In-Band Manageability Developer Guide.md Outdated Show resolved Hide resolved
inbm/Changelog.md Outdated Show resolved Hide resolved
inbm/Changelog.md Outdated Show resolved Hide resolved
@tsirlapu tsirlapu changed the title [source] Remove ubuntuAptSource configuration tag and underlying code [source] Removal of ubuntuAptSource tag and code with adoption of the new 'source' mechanism. Jan 31, 2024
@gblewis1
Copy link
Contributor

gblewis1 commented Feb 1, 2024

@tsirlapu I see that you've marked ubuntuAptSource as removed from the 4.2.0 version, but that's actually not true; 4.2.0 still has ubuntuAptSource. It would be better to simply say it's removed, period. as the person reading the docs would be reading them from the new version that has it removed, and not 4.2.0 or earlier.

@tsirlapu tsirlapu changed the title [source] Removal of ubuntuAptSource tag and code with adoption of the new 'source' mechanism. [Breaking Change] Removal of ubuntuAptSource tag and code with adoption of the new 'source' mechanism. Feb 1, 2024
@tsirlapu tsirlapu changed the title [Breaking Change] Removal of ubuntuAptSource tag and code with adoption of the new 'source' mechanism. (BREAKING CHANGE) RTC 536910 - [source] Remove ubuntuAptSource INBM configuration tag and underlying code; replaced with source command Feb 1, 2024
@tsirlapu tsirlapu merged commit 5cf155b into develop Feb 1, 2024
7 checks passed
@tsirlapu tsirlapu deleted the remove_tag2 branch February 1, 2024 22:40
@umital-intel
Copy link

/generate_report

@nex-maximus
Copy link
Collaborator

Please provide the PR description rating here on a scale of 1 to 5 (1 being the lowest and 5 being the highest) -

Summary Report of Code Review Evaluation metrics for the Repository:

Code defects Acceptance ratio: 0/0

Code improvements Acceptance ratio: 3/4 (75.0%)

Code fixes Acceptance ratio: 0/0

7 Approvals 1 Dispprovals 4 Neutral 1 Response Pending
#472 (comment)

#472 (comment)

#472 (comment)

#472 (comment)

#472 (comment)

#472 (comment)

#472 (comment)
#472 (comment) #472 (comment)

#472 (comment)

#472 (comment)

#472 (comment)
#472 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants