feat(cli): Add functionality to operate on Secrets

[anudeeps352]

User description

Description

Add functionality to operate on Secrets

Fixes #302

Screenshots of relevant screens

Add screenshots of relevant screens

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

PR Type

Enhancement

---

Description

• Added a new SecretCommand class to manage secrets via CLI, including subcommands for creating, deleting, listing, fetching, updating, and rolling back secrets.
• Implemented CreateSecret, DeleteSecret, GetSecret, ListSecret, FetchSecretRevisions, RollbackSecret, and UpdateSecret classes, each handling specific secret operations.
• Registered SecretCommand in the CLI command list to enable secret management functionality.

---

Changes walkthrough 📝

Relevant files

Enhancement

9 files secret.command.ts Add SecretCommand class with subcommands for CLI                  apps/cli/src/commands/secret.command.ts Introduced SecretCommand class extending BaseCommand. Added subcommands for managing secrets. Implemented getName, getDescription, and getSubCommands methods. +30/-0    create.secret.ts Implement CreateSecret command for secret creation              apps/cli/src/commands/secret/create.secret.ts Created CreateSecret class for creating secrets. Defined command arguments and options. Implemented action method to handle secret creation. +129/-0  delete.secret.ts Implement DeleteSecret command for secret deletion              apps/cli/src/commands/secret/delete.secret.ts Added DeleteSecret class for deleting secrets. Defined command arguments. Implemented action method to handle secret deletion. +44/-0    get.secret.ts Implement GetSecret command for retrieving secrets              apps/cli/src/commands/secret/get.secret.ts Introduced GetSecret class for retrieving secrets. Defined command arguments and options. Implemented action method to fetch secrets. +75/-0    list.secret.ts Implement ListSecret command for listing secrets                  apps/cli/src/commands/secret/list.secret.ts Created ListSecret class for listing secrets. Defined command arguments. Implemented action method to list secrets. +56/-0    revisions.secret.ts Implement FetchSecretRevisions command for secret revisions apps/cli/src/commands/secret/revisions.secret.ts Added FetchSecretRevisions class for fetching secret revisions. Defined command arguments. Implemented action method to retrieve revisions. +62/-0    rollback.secret.ts Implement RollbackSecret command for secret rollback          apps/cli/src/commands/secret/rollback.secret.ts Introduced RollbackSecret class for rolling back secrets. Defined command arguments and options. Implemented action method to perform rollback. +79/-0    update.secret.ts Implement UpdateSecret command for secret updates                apps/cli/src/commands/secret/update.secret.ts Created UpdateSecret class for updating secrets. Defined command arguments and options. Implemented action method to update secrets. +77/-0    index.ts Register SecretCommand in CLI command list                              apps/cli/src/index.ts Added SecretCommand to the list of CLI commands. +2/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 302 - Fully compliant Fully compliant requirements: List all secrets under a project Fetch all revisions of a secret Create a secret Update a secret Rollback a secret Delete a secret

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪

🧪 No relevant tests

🔒 Security concerns Sensitive information exposure: In the ListSecret class (apps/cli/src/commands/secret/list.secret.ts), there's a console.log(data) statement that might expose sensitive secret information. This should be removed or replaced with a more secure logging method that doesn't reveal secret values.

⚡ Recommended focus areas for review Error Handling The parseInput method doesn't handle all possible error cases, such as invalid rotateAfter values. Potential Security Issue The console.log(data) statement may expose sensitive information. Consider removing or replacing with a more secure logging method. Input Validation The action method passes options directly to the controller without validation, which could lead to unexpected behavior or security issues.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Security	Remove unnecessary console.log statement to prevent potential information leakage Remove the console.log statement as it's not necessary and may expose sensitive information in production. apps/cli/src/commands/secret/list.secret.ts [42-45] if (success) { - console.log(data) const secrets = data if (secrets.length > 0) { Apply this suggestion Suggestion importance[1-10]: 9 Why: Removing the console.log statement is crucial for preventing potential information leakage, especially in a production environment where sensitive data might be exposed inadvertently.	9
Possible issue	Validate the rotateAfter option to ensure only accepted values are used Add input validation for the rotateAfter option to ensure it only accepts valid values. apps/cli/src/commands/secret/create.secret.ts [122-128] +const validRotateAfterValues = ['24', '168', '720', '8760', 'never']; +if (rotateAfter && !validRotateAfterValues.includes(rotateAfter)) { + throw new Error('Invalid rotateAfter value. Must be 24, 168, 720, 8760, or never.'); +} return { name, note, rotateAfter, entries: parsedEntries } Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding input validation for the rotateAfter option is important to prevent invalid values from being processed, which could lead to unexpected behavior or errors.	8
	Validate the rotate-after option in the update command to ensure only accepted values are used Add input validation for the rotate-after option to ensure it only accepts valid values, similar to the create command. apps/cli/src/commands/secret/update.secret.ts [55-64] async action({ args, options }: CommandActionData): Promise<void> { const [secretSlug] = args + const validRotateAfterValues = ['24', '168', '720', '8760', 'never']; + if (options.rotateAfter && !validRotateAfterValues.includes(options.rotateAfter)) { + Logger.error('Invalid rotate-after value. Must be 24, 168, 720, 8760, or never.'); + return; + } const { data, error, success } = await ControllerInstance.getInstance().secretController.updateSecret( { secretSlug, ...options }, this.headers ) Suggestion importance[1-10]: 8 Why: Similar to the create command, input validation for the rotate-after option in the update command is necessary to ensure data integrity and prevent invalid values from causing issues.	8
Enhancement	Improve readability and consistency of logged revision information Use template literals for better readability and consistency when logging revision information. apps/cli/src/commands/secret/revisions.secret.ts [47-53] -Logger.info(`Id ${revision.id}`) -Logger.info(`value ${revision.value}`) -Logger.info(`version ${revision.version}`) -Logger.info(`secretID ${revision.secretId}`) -Logger.info(`Created On ${revision.createdOn}`) -Logger.info(`Created By Id ${revision.createdById}`) -Logger.info(`environmentId ${revision.environmentId}`) +Logger.info(`Id: ${revision.id}`) +Logger.info(`Value: ${revision.value}`) +Logger.info(`Version: ${revision.version}`) +Logger.info(`Secret ID: ${revision.secretId}`) +Logger.info(`Created On: ${revision.createdOn}`) +Logger.info(`Created By Id: ${revision.createdById}`) +Logger.info(`Environment ID: ${revision.environmentId}`) Apply this suggestion Suggestion importance[1-10]: 5 Why: While using template literals with added labels improves readability and consistency, the impact is moderate as it does not affect functionality or address any critical issues.	5

💡 Need additional feedback ? start a PR chat

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.64%. Comparing base (ce50743) to head (87e9d3a).
Report is 194 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #504      +/-   ##
===========================================
- Coverage    91.71%   87.64%   -4.08%     
===========================================
  Files          111      105       -6     
  Lines         2510     2743     +233     
  Branches       469      415      -54     
===========================================
+ Hits          2302     2404     +102     
- Misses         208      339     +131     

Flag	Coverage Δ
api-e2e-tests	87.64% <ø> (-4.08%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rajdip-b]

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀