support access keys

[amirmalka]

PR Type:

Enhancement

---

PR Description:

This PR introduces support for access keys in the backend API. The main changes include:

• Adding an API endpoint for access keys.
• Modifying the login method to retrieve and set access keys.
• Updating the tenant creation method to return the tenant's access key.
• Adding a method to retrieve access keys.
• Updating various scripts to accommodate the use of access keys.

---

PR Main Files Walkthrough:

files:

infrastructure/backend_api.py: Added an API endpoint for access keys. Modified the login method to retrieve and set access keys. Updated the tenant creation method to return the tenant's access key. Added a method to retrieve access keys.
infrastructure/helm_wrapper.py: Updated the method for installing the Armo Helm chart to include the access key.
systest_utils/systests_utilities.py: Updated the run_command method to accept an environment variable dictionary.
tests_scripts/base_test.py: Updated the method for creating a new tenant to set the access key.
tests_scripts/helm/base_helm.py: Updated the method for installing the Armo Helm chart to include the access key.
tests_scripts/kubescape/base_kubescape.py: Updated the methods for downloading policy and scanning to include the access key.
infrastructure/backendapi.md: Updated the documentation to reflect the changes made in the backend API related to access keys.

[codiumai-pr-agent-free]

PR Analysis

• 🎯 Main theme: Introducing support for access keys in the backend API
• 📝 PR summary: This PR introduces support for access keys in the backend API. It includes adding an API endpoint for access keys, modifying the login method to retrieve and set access keys, updating the tenant creation method to return the tenant's access key, adding a method to retrieve access keys, and updating various scripts to accommodate the use of access keys.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 4, due to the significant changes in the backend API and the need to ensure that the access keys are handled securely and correctly.
• 🔒 Security concerns: Yes, the PR introduces the use of access keys, which if not handled securely, could lead to potential security vulnerabilities. It is important to ensure that the access keys are stored and transmitted securely, and that they are not exposed in any logs or error messages.

PR Feedback

• 💡 General suggestions: The PR seems to be well-structured and the changes are logically grouped. However, it would be beneficial to ensure that the access keys are being handled securely, especially in terms of storage and transmission. Additionally, it would be helpful to add tests to verify the correct functionality of the new features.

• 🤖 Code feedback:

  • relevant file: infrastructure/backend_api.py
    suggestion: Consider adding error handling for the case where the access keys retrieval fails or returns an unexpected result. This will make the code more robust and easier to debug. [important]
    relevant line: "+ access_keys_response = self.get_access_keys()"

  • relevant file: infrastructure/backend_api.py
    suggestion: It might be a good idea to validate the access key before setting it. This could include checking that it is not empty and possibly checking its format if there are specific requirements. [medium]
    relevant line: "+ self.set_access_key(access_keys[0]['value'])"

  • relevant file: tests_scripts/base_test.py
    suggestion: It would be beneficial to add a check to ensure that the access key is not empty after it is set. This will help to catch any issues early on. [medium]
    relevant line: "+ self.backend.set_access_key(test_tenant_access_key)"

  • relevant file: tests_scripts/kubescape/base_kubescape.py
    suggestion: Consider adding a check to ensure that the access key is not empty before using it in the scan command. This will help to prevent any issues that could arise from an empty access key. [medium]
    relevant line: "+ env = {'KS_ACCESS_KEY': self.backend.get_access_key()} if self.backend.get_access_key() != '' else {}"

How to use

To invoke the PR-Agent, add a comment using 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.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.

[github-actions]

PR Analysis

• 🎯 Main theme: Adding support for access keys in the backend API and updating the relevant tests and scripts.
• 📝 PR summary: This PR introduces support for access keys in the backend API. It includes changes to the backend API to fetch and set access keys, and updates to the relevant tests and scripts to accommodate this new feature. The PR also includes updates to the documentation to reflect these changes.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 4, because the PR involves changes across multiple files, including core backend API, tests, and scripts. Understanding the impact of these changes requires a good understanding of the entire system.
• 🔒 Security concerns: No

PR Feedback

• 💡 General suggestions: The PR is well-structured and the changes are logically grouped. However, it would be beneficial to include tests that specifically verify the new functionality introduced by the access keys. Additionally, it would be helpful to include more context or comments in the code to explain the purpose and usage of the access keys.

• 🤖 Code feedback:

  • relevant file: infrastructure/backend_api.py
    suggestion: Consider handling the case where the access keys are not found or the response is not as expected in a more robust way. Instead of asserting, you could raise a custom exception that provides more context about the error. [important]
    relevant line: assert len(access_keys) != 0, f"Expected access keys, found none"

  • relevant file: infrastructure/backend_api.py
    suggestion: It seems like the access key is being added to the auth dictionary. It would be better to encapsulate this logic in a separate method to improve code readability and maintainability. [medium]
    relevant line: self.auth["X-API-KEY"] = self.access_key

  • relevant file: tests_scripts/kubescape/base_kubescape.py
    suggestion: It would be beneficial to add error handling for the case where the access key is not found or is empty. This would make the code more robust and easier to debug. [important]
    relevant line: env = {"KS_ACCESS_KEY": self.backend.get_access_key()} if self.backend.get_access_key() != "" else {}

  • relevant file: tests_scripts/base_test.py
    suggestion: It would be beneficial to add error handling for the case where the access key is not found or is empty. This would make the code more robust and easier to debug. [important]
    relevant line: self.backend.set_access_key(test_tenant_access_key)

How to use

To invoke the PR-Agent, add a comment using 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.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.