Add support to customizing certbot cert command #2019
Conversation
- Added getCertbotCertCommand method in CertbotManager for dynamic cert commands - Refactored enableSsl method to use the new dynamic cert command generator - Introduced certbotCertCommand configuration in CaptainConstants for customizable commands
- Extracted certificate success logic into isCertCommandSuccess function - Ensured compatibility with previous certbot success messages
- Removed a redundant comma in function arguments - Added a space before function declaration for consistency
- Introduced CertbotCertCommandRule for dynamic command generation - Refactored CertbotManager to utilize a CertCommandGenerator - Added new tests for the CertCommandGenerator logic
|
@githubsaturn Could you please let me know when you might have time to review the latest pull request? I appreciate your feedback on it. |
|
|
||
| certbotImageName: 'caprover/certbot-sleeping:v1.6.0', | ||
|
|
||
| certbotCertCommand: undefined as CertbotCertCommandRule[] | undefined, |
There was a problem hiding this comment.
Rename certbotCertCommand to certbotCertCommandRules
| /** | ||
| * The Certbot command to execute, in Docker exec form, uses `${domain}` as the placeholder for the actual domain name | ||
| */ | ||
| command?: string[]; |
There was a problem hiding this comment.
Let's use command?: string, when passing to exec, we can do command.trim().split(' ')
This will make it much easier to override and read.
| } | ||
| return this.defaultCommand | ||
| } | ||
| getCertbotCertCommand(domainName: string, variables: Record<string, string> = {}): string[] { |
There was a problem hiding this comment.
The only place this command gets called we have:
const cmd = self.certCommandGenerator.getCertbotCertCommand(domainName, {
domain: domainName,
webroot: WEBROOT_PATH_IN_CERTBOT + '/' + domainName
})
Looks like the flexibility in the args is really not needed and causes more confusion. Let's just change the signature to be explicit. i.e.,
getCertbotCertCommand(domainName: string, webroot:string)
| @@ -12,8 +12,36 @@ const WEBROOT_PATH_IN_CAPTAIN = | |||
|
|
|||
| const shouldUseStaging = false // CaptainConstants.isDebug; | |||
|
|
|||
| function isCertCommandSuccess(output: string) { | |||
|
Hi @ZeekoZhu |
Please see comments on #1761 for more details.
Most important items
These rules are strictly enforced to make sure that we can maintain the project moving forward.