refactor: moved a lot of flags & added comments

Comments added to fix the golint errors on exported things need comments
This commit is contained in:
2021-08-02 07:36:35 +01:00
parent 9070806f8d
commit 38d8b51bd5
18 changed files with 330 additions and 248 deletions

View File

@ -4,6 +4,7 @@ import (
"github.com/urfave/cli/v2"
)
// AppCommand defines the `abra app` command and ets subcommands
var AppCommand = &cli.Command{
Name: "app",
Usage: "Manage your apps",

View File

@ -1,11 +1,18 @@
package app
import (
"coopcloud.tech/abra/cli/internal"
"github.com/urfave/cli/v2"
)
var backupAllServices bool
var backupAllServicesFlag = &cli.BoolFlag{
Name: "all",
Value: false,
Destination: &backupAllServices,
Usage: "Backup all services",
}
var appBackupCommand = &cli.Command{
Name: "backup",
Flags: []cli.Flag{internal.AllFlag},
Flags: []cli.Flag{backupAllServicesFlag},
}

View File

@ -1,16 +1,44 @@
package app
import (
"coopcloud.tech/abra/cli/internal"
"github.com/urfave/cli/v2"
)
var force bool
var forceFlag = &cli.BoolFlag{
Name: "force",
Value: false,
Destination: &force,
}
var update bool
var updateFlag = &cli.BoolFlag{
Name: "update",
Value: false,
Destination: &update,
}
var noDomainPoll bool
var noDomainPollFlag = &cli.BoolFlag{
Name: "no-domain-poll",
Value: false,
Destination: &noDomainPoll,
}
// skipVersionCheck stores the variable from SkipVersionCheckFlag
var skipVersionCheck bool
var skipVersionCheckFlag = &cli.BoolFlag{
Name: "skip-version-check",
Value: false,
Destination: &skipVersionCheck,
}
var appDeployCommand = &cli.Command{
Name: "deploy",
Flags: []cli.Flag{
internal.UpdateFlag,
internal.ForceFlag,
internal.SkipVersionCheckFlag,
internal.NoDomainPollFlag,
updateFlag,
forceFlag,
skipVersionCheckFlag,
noDomainPollFlag,
},
}

View File

@ -4,12 +4,38 @@ import (
"sort"
abraFormatter "coopcloud.tech/abra/cli/formatter"
"coopcloud.tech/abra/cli/internal"
"coopcloud.tech/abra/config"
"github.com/sirupsen/logrus"
"github.com/urfave/cli/v2"
)
var status bool
var statusFlag = &cli.BoolFlag{
Name: "status",
Aliases: []string{"S"},
Value: false,
Usage: "Show app deployment status",
Destination: &status,
}
var appType string
var typeFlag = &cli.StringFlag{
Name: "type",
Aliases: []string{"t"},
Value: "",
Usage: "Show apps of a specific type",
Destination: &appType,
}
var listAppServer string
var listAppServerFlag = &cli.StringFlag{
Name: "server",
Aliases: []string{"s"},
Value: "",
Usage: "Show apps of a specific server",
Destination: &listAppServer,
}
var appListCommand = &cli.Command{
Name: "list",
Usage: "List all managed apps",
@ -22,9 +48,13 @@ actual live deployment status. Depending on how many servers you manage, this
can take some time.
`,
Aliases: []string{"ls"},
Flags: []cli.Flag{internal.StatusFlag, internal.ServerFlag, internal.TypeFlag},
Flags: []cli.Flag{
statusFlag,
listAppServerFlag,
typeFlag,
},
Action: func(c *cli.Context) error {
appFiles, err := config.LoadAppFiles(internal.Server)
appFiles, err := config.LoadAppFiles(listAppServer)
if err != nil {
logrus.Fatal(err)
}
@ -37,7 +67,7 @@ can take some time.
statuses := map[string]string{}
tableCol := []string{"Server", "Type", "Domain"}
if internal.Status {
if status {
tableCol = append(tableCol, "Status")
statuses, err = config.GetAppStatuses(appFiles)
if err != nil {
@ -50,10 +80,10 @@ can take some time.
for _, app := range apps {
var tableRow []string
if app.Type == internal.Type || internal.Type == "" {
if app.Type == appType || appType == "" {
// If type flag is set, check for it, if not, Type == ""
tableRow = []string{app.File.Server, app.Type, app.Domain}
if internal.Status {
if status {
if status, ok := statuses[app.StackName()]; ok {
tableRow = append(tableRow, status)
} else {

View File

@ -15,7 +15,34 @@ import (
"github.com/urfave/cli/v2"
)
type Secrets map[string]string
type secrets map[string]string
var domain string
var domainFlag = &cli.StringFlag{
Name: "domain",
Aliases: []string{"d"},
Value: "",
Usage: "Choose a domain name",
Destination: &domain,
}
var newAppServer string
var newAppServerFlag = &cli.StringFlag{
Name: "server",
Aliases: []string{"s"},
Value: "",
Usage: "Show apps of a specific server",
Destination: &listAppServer,
}
var newAppName string
var newAppNameFlag = &cli.StringFlag{
Name: "app-name",
Aliases: []string{"a"},
Value: "",
Usage: "Choose an app name",
Destination: &newAppName,
}
var appNewDescription = `
This command takes an app recipe and uses it to create a new app. This new app
@ -42,9 +69,9 @@ var appNewCommand = &cli.Command{
Usage: "Create a new app",
Description: appNewDescription,
Flags: []cli.Flag{
internal.ServerFlag,
internal.DomainFlag,
internal.AppNameFlag,
newAppServerFlag,
domainFlag,
newAppNameFlag,
internal.PassFlag,
internal.SecretsFlag,
},
@ -70,11 +97,11 @@ func appLookup(appType string) (catalogue.App, error) {
// ensureDomainFlag checks if the domain flag was used. if not, asks the user for it
func ensureDomainFlag() error {
if internal.Domain == "" {
if domain == "" {
prompt := &survey.Input{
Message: "Specify app domain",
}
if err := survey.AskOne(prompt, &internal.Domain); err != nil {
if err := survey.AskOne(prompt, &domain); err != nil {
return err
}
}
@ -83,17 +110,17 @@ func ensureDomainFlag() error {
// ensureServerFlag checks if the server flag was used. if not, asks the user for it
func ensureServerFlag() error {
appFiles, err := config.LoadAppFiles(internal.Server)
appFiles, err := config.LoadAppFiles(newAppServer)
if err != nil {
return err
}
servers := appFiles.GetServers()
if internal.Server == "" {
if newAppServer == "" {
prompt := &survey.Select{
Message: "Select app server:",
Options: servers,
}
if err := survey.AskOne(prompt, &internal.Server); err != nil {
if err := survey.AskOne(prompt, &newAppServer); err != nil {
return err
}
}
@ -102,27 +129,27 @@ func ensureServerFlag() error {
// ensureServerFlag checks if the AppName flag was used. if not, asks the user for it
func ensureAppNameFlag() error {
if internal.AppName == "" {
if newAppName == "" {
prompt := &survey.Input{
Message: "Specify app name:",
Default: config.SanitiseAppName(internal.Domain),
Default: config.SanitiseAppName(domain),
}
if err := survey.AskOne(prompt, &internal.AppName); err != nil {
if err := survey.AskOne(prompt, &newAppName); err != nil {
return err
}
}
return nil
}
func createSecrets(sanitisedAppName string) (Secrets, error) {
appEnvPath := path.Join(config.ABRA_DIR, "servers", internal.Server, fmt.Sprintf("%s.env", sanitisedAppName))
func createSecrets(sanitisedAppName string) (secrets, error) {
appEnvPath := path.Join(config.ABRA_DIR, "servers", newAppServer, fmt.Sprintf("%s.env", sanitisedAppName))
appEnv, err := config.ReadEnv(appEnvPath)
if err != nil {
return nil, err
}
secretEnvVars := secret.ReadSecretEnvVars(appEnv)
secrets, err := secret.GenerateSecrets(secretEnvVars, sanitisedAppName, internal.Server)
secrets, err := secret.GenerateSecrets(secretEnvVars, sanitisedAppName, newAppServer)
if err != nil {
return nil, err
}
@ -130,7 +157,7 @@ func createSecrets(sanitisedAppName string) (Secrets, error) {
if internal.Pass {
for secretName := range secrets {
secretValue := secrets[secretName]
if err := secret.PassInsertSecret(secretValue, secretName, sanitisedAppName, internal.Server); err != nil {
if err := secret.PassInsertSecret(secretValue, secretName, sanitisedAppName, newAppServer); err != nil {
return nil, err
}
}
@ -171,12 +198,12 @@ func action(c *cli.Context) error {
logrus.Fatal(err)
}
sanitisedAppName := config.SanitiseAppName(internal.AppName)
sanitisedAppName := config.SanitiseAppName(newAppName)
if len(sanitisedAppName) > 45 {
logrus.Fatalf("'%s' cannot be longer than 45 characters", sanitisedAppName)
}
if err := config.CopyAppEnvSample(appType, internal.AppName, internal.Server); err != nil {
if err := config.CopyAppEnvSample(appType, newAppName, newAppServer); err != nil {
logrus.Fatal(err)
}
@ -197,7 +224,7 @@ func action(c *cli.Context) error {
tableCol := []string{"Name", "Domain", "Type", "Server"}
table := abraFormatter.CreateTable(tableCol)
table.Append([]string{sanitisedAppName, internal.Domain, appType, internal.Server})
table.Append([]string{sanitisedAppName, domain, appType, newAppServer})
defer table.Render()
return nil

View File

@ -5,7 +5,20 @@ import (
"github.com/urfave/cli/v2"
)
var appRemoveCommand = &cli.Command{
Name: "remove",
Flags: []cli.Flag{internal.VolumesFlag, internal.SecretsFlag},
// Volumes stores the variable from VolumesFlag
var Volumes bool
// VolumesFlag is used to specify if volumes should be deleted when deleting an app
var VolumesFlag = &cli.BoolFlag{
Name: "volumes",
Value: false,
Destination: &Volumes,
}
var appRemoveCommand = &cli.Command{
Name: "remove",
Flags: []cli.Flag{
VolumesFlag,
internal.SecretsFlag,
},
}

View File

@ -1,12 +1,19 @@
package app
import (
"coopcloud.tech/abra/cli/internal"
"github.com/urfave/cli/v2"
)
var restoreAllServices bool
var restoreAllServicesFlag = &cli.BoolFlag{
Name: "all",
Value: false,
Destination: &restoreAllServices,
Usage: "Restore all services",
}
var appRestoreCommand = &cli.Command{
Name: "restore",
Flags: []cli.Flag{internal.AllFlag},
Flags: []cli.Flag{restoreAllServicesFlag},
ArgsUsage: "<service> [<backup file>]",
}

View File

@ -1,15 +1,28 @@
package app
import (
"coopcloud.tech/abra/cli/internal"
"github.com/urfave/cli/v2"
)
var user string
var userFlag = &cli.StringFlag{
Name: "user",
Value: "",
Destination: &user,
}
var noTTY bool
var noTTYFlag = &cli.BoolFlag{
Name: "no-tty",
Value: false,
Destination: &noTTY,
}
var appRunCommand = &cli.Command{
Name: "run",
Flags: []cli.Flag{
internal.NoTTYFlag,
internal.UserFlag,
noTTYFlag,
userFlag,
},
ArgsUsage: "<service> <args>...",
}

View File

@ -9,11 +9,19 @@ import (
"github.com/urfave/cli/v2"
)
var allSecrets bool
var allSecretsFlag = &cli.BoolFlag{
Name: "all",
Value: false,
Destination: &allSecrets,
Usage: "Generate all secrets",
}
// TODO: Replicating what the bash abra does might be hard
// with the mix of subcommands and flags
var appSecretCommand = &cli.Command{
Name: "secret",
Flags: []cli.Flag{internal.AllFlag, internal.PassFlag},
Flags: []cli.Flag{allSecretsFlag, internal.PassFlag},
Action: func(c *cli.Context) error {
password, err := secret.GeneratePassphrases(1)
if err != nil {