globocom / huskyCI

Performing security tests inside your CI
https://huskyci.opensource.globo.com
BSD 3-Clause "New" or "Revised" License
572 stars 137 forks source link

Husky Client Enhancement - Print API Target Information #571

Open fguisso opened 1 year ago

fguisso commented 1 year ago
  1. Problem Description:

    • The current behavior of the Husky client does not provide any information about the API target when the analysis starts, making it challenging to identify the environment it is interacting with.
  2. Steps to Reproduce:

    • Run the Husky client without any specific configuration or parameters, and observe that the analysis starts without printing information about the API target.
  3. Expected Behavior:

    • When the Husky client is executed for analysis, it should print out essential information about the API target, such as the URL, version, or any other relevant details.
  4. Current Behavior:

    • The Husky client starts the analysis without providing any information about the API target, hindering the ability to verify the target environment.
  5. Proposed Changes:

    • Enhance the Husky client to print out crucial information about the API target at the beginning of the analysis.
    • Include details such as the API URL, version, and any other relevant information that aids in understanding the context of the analysis.
  6. Dependencies:

    • Husky client source code lives in client directory.
  7. Testing:

    • Test the modified Husky client to ensure that it prints out the API target information at the start of the analysis.
    • Verify that the output is clear and includes essential details.
  8. Documentation Updates:

    • Update the project documentation to inform users about the new feature and explain the significance of the API target information displayed by the Husky client.
  9. Expected Impact:

    • The enhanced Husky client will provide users and maintainers with vital information about the API target, improving the visibility and ease of use during analysis.

Note: Ensure that the proposed changes adhere to the coding conventions and standards of the Husky client project. Provide a link to the Husky client's repository for reference.