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

Fix SOTA to not reboot twice on EXT4 system #481

Merged
merged 5 commits into from
Feb 8, 2024
Merged

Fix SOTA to not reboot twice on EXT4 system #481

merged 5 commits into from
Feb 8, 2024

Conversation

tsirlapu
Copy link
Contributor

@tsirlapu tsirlapu commented Feb 8, 2024

RTC 530960

Fix SOTA snapshot conditionali statements

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...
Fix SOTA snapshot conditionali statements

REFERENCES

Reference URL for issue tracking (JIRA/HSD/Github): <URL to be filled>
https://rtc.intel.com/ccm0006001/web/projects/SSEA-%20IOTG%20PED%20Team#action=com.ibm.team.workitem.viewWorkItem&id=530960&oslc_config.context=https://rtc.intel.com/gc/configuration/4491

  • 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 530960

Fix SOTA snapshot conditionali statements
@tsirlapu
Copy link
Contributor Author

tsirlapu commented Feb 8, 2024

/Review

@nex-maximus
Copy link
Collaborator

Code Review Analysis

  • 🎯 Main theme: The PR addresses a specific issue where a system would reboot twice during a SOTA (Software Over The Air) update on EXT4 filesystems. The changes involve modifying conditional checks to prevent unnecessary rollbacks and reboots when the snapshot number is "0".
  • 📝 PR summary: This PR introduces changes to the snapshot handling logic in the SOTA update process. It modifies the conditions under which a rollback and reboot are triggered, specifically avoiding these actions when the snapshot number is "0", which indicates that no snapshot was taken.
  • 📌 Type of PR: Bug fix
  • 🏅 Score: 85
  • 🧪 Relevant tests added: No
  • ⏱️ Estimated effort to review [1-5]: 2, because the PR is focused on a specific issue with a clear description, and the changes are limited to a few lines of code in a single module.
  • 🔒 Security concerns: No

Code Review Feedback

💡 General suggestions: The PR seems to address the issue described, and the changes are clear and concise. However, it is important to ensure that the snapshot number "0" is indeed the correct indicator for no snapshot taken and that there are no edge cases where "0" could be a valid snapshot number. Additionally, it would be beneficial to add relevant unit tests to cover these changes and ensure that the new logic behaves as expected in different scenarios.

✨ 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/snapshot.py Outdated Show resolved Hide resolved
inbm/dispatcher-agent/dispatcher/sota/snapshot.py Outdated Show resolved Hide resolved
inbm/dispatcher-agent/dispatcher/sota/snapshot.py Outdated Show resolved Hide resolved
inbm/Changelog.md Outdated Show resolved Hide resolved
@tsirlapu tsirlapu merged commit af0ec53 into develop Feb 8, 2024
15 checks passed
@tsirlapu tsirlapu deleted the sota_snap0 branch February 8, 2024 23:03
@gblewis1
Copy link
Contributor

/review

@nex-maximus
Copy link
Collaborator

$\color{#FFA500}CODE \space REVIEW \space STARTED$

@nex-maximus
Copy link
Collaborator

Preparing review...

@nex-maximus
Copy link
Collaborator

Incremental PR Review

Code Review Analysis

  • PR summary: This PR addresses an issue where systems with EXT4 filesystems would reboot twice during the SOTA (Software Over The Air) update process. It corrects conditional statements related to snapshot management to ensure that unnecessary reboots are avoided, enhancing the update process's efficiency and reliability.
  • PR Category: Bug fix
  • Security concerns: No

Code Review Feedback

General suggestions: The PR successfully addresses the critical issue of avoiding unnecessary reboots during the SOTA process on EXT4 systems by fixing conditional checks. It's essential to ensure that such changes are thoroughly tested across different system configurations to prevent any unforeseen issues. Additionally, considering the importance of sustainability mentioned in the PR description, it would be beneficial to include inline comments explaining the rationale behind key changes for future maintainability.

User guidelines:

Tag me in a comment '@nex-maximus' and add one of the following commands:
/review [-all]: Request a review of your Pull Request. By default, the agent considers changes since the last review For including all the files in PR, which only include the '-all' 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: ..."

@nex-maximus
Copy link
Collaborator

Preparing code suggestions...

@nex-maximus
Copy link
Collaborator

$\color{#FFA500}CODE \space REVIEW \space ENDED$

If you wish to include any dependent files which are not in the PR, add the details in:
1. .github/dependent_files.json
(or)
2. pass it via the comment in this format -> /review -all --dependent_files=file1.py, scr2/file2.py

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

Successfully merging this pull request may close these issues.

3 participants