Skip to content

Commit

Permalink
Switch to spf13/cobra from urfave/cli
Browse files Browse the repository at this point in the history
There's A LOT happening in this commit, so here's an outline:

- First off, urfave/cli has been removed in favour of spf13/cobra. With
  this, comes changes to the formatting as well as the help page for
  Kompose.

- Upon converting, I noticed a CLI flag was NOT appearing for OpenShift.
  Specifically, `--deploymentconfig`. This has been added with a note
  that says it is OpenShift only.

- Exit codes have been fixed. If the conversion / down / up fails for
  any reason, Kompose will exit with Code 1.

- `--verbose` as well as `--suppress-warnings` can now be set at the
  same time.

- `app_test.go` in the cli directory has been moved to `pkg/transformer`
  to better reflect the testing coverage.

- `version.go` has been removed and converted to it's own CLI command in
  conjuction with (most) Go software. A new CLI command has been
  created. `kompose version`

- `--dab` isn't a conventional way for short-form CLI paramters. This
  has been shortened to `-b` for bundle.

- `--replicas` has been added as an option when using `kompose down` or
  `kompose up`. This has been added as previously in `app.go` the
  replica amount was hard-coded as `1`.

- Differentiating names have been used for flags. For example,
  persistent flags use the name Global (ex. GlobalOut). Command-specific
  flags have their own names (ex. UpOpt).
  • Loading branch information
cdrage committed Dec 19, 2016
1 parent 072d481 commit 9aa3edf
Show file tree
Hide file tree
Showing 9 changed files with 374 additions and 341 deletions.
260 changes: 0 additions & 260 deletions cli/command/command.go

This file was deleted.

129 changes: 129 additions & 0 deletions cmd/convert.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
/*
Copyright 2016 The Kubernetes Authors All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package cmd

import (
"github.com/kubernetes-incubator/kompose/pkg/app"
"github.com/kubernetes-incubator/kompose/pkg/kobject"
"github.com/spf13/cobra"
"github.com/spf13/viper"
"strings"
)

var (
ConvertSource, ConvertOut string
ConvertChart, ConvertDeployment, ConvertDaemonSet bool
ConvertReplicationController, ConvertYaml, ConvertStdout bool
ConvertEmptyVols, ConvertDeploymentConfig bool
ConvertReplicas int
ConvertOpt kobject.ConvertOptions
)

var ConvertProvider string = GlobalProvider

var convertCmd = &cobra.Command{
Use: "convert [file]",
Short: "Convert a Docker Compose file",
PreRun: func(cmd *cobra.Command, args []string) {

// Create the Convert Options.
ConvertOpt = kobject.ConvertOptions{
ToStdout: ConvertStdout,
CreateChart: ConvertChart,
GenerateYaml: ConvertYaml,
Replicas: ConvertReplicas,
InputFile: GlobalFile,
OutFile: ConvertOut,
Provider: strings.ToLower(GlobalProvider),
CreateD: ConvertDeployment,
CreateDS: ConvertDaemonSet,
CreateRC: ConvertReplicationController,
CreateDeploymentConfig: ConvertDeploymentConfig,
EmptyVols: ConvertEmptyVols,
}

// Validate before doing anything else. Use "bundle" if passed in.
app.ValidateFlags(GlobalBundle, args, cmd.Flags().Lookup("file").Changed, &ConvertOpt)
},
Run: func(cmd *cobra.Command, args []string) {

app.Convert(ConvertOpt)
},
}

func init() {

// Automatically grab environment variables
viper.AutomaticEnv()

// Kubernetes only
convertCmd.Flags().BoolVarP(&ConvertChart, "chart", "c", false, "Create a Helm chart for converted objects")
convertCmd.Flags().BoolVar(&ConvertDaemonSet, "daemon-set", false, "Generate a Kubernetes daemonset object")
convertCmd.Flags().BoolVar(&ConvertReplicationController, "replication-controller", false, "Generate a Kubernetes replication controller object")
convertCmd.Flags().MarkHidden("chart")
convertCmd.Flags().MarkHidden("daemon-set")
convertCmd.Flags().MarkHidden("replication-controller")

// OpenShift only
convertCmd.Flags().BoolVarP(&ConvertDeployment, "deployment", "d", false, "Generate an OpenShift deployment object")
convertCmd.Flags().BoolVar(&ConvertDeploymentConfig, "deployment-config", true, "Generate an OpenShift deploymentconfig object")
convertCmd.Flags().MarkHidden("deployment")
convertCmd.Flags().MarkHidden("deployment-config")

// Standard between the two
convertCmd.Flags().BoolVarP(&ConvertYaml, "yaml", "y", false, "Generate resource files into yaml format")
convertCmd.Flags().BoolVar(&ConvertStdout, "stdout", false, "Print converted objects to stdout")
convertCmd.Flags().BoolVar(&ConvertEmptyVols, "emptyvols", false, "Use Empty Volumes. Do not generate PVCs")
convertCmd.Flags().StringVarP(&ConvertOut, "out", "o", "", "Specify a file name to save objects to")
convertCmd.Flags().IntVar(&ConvertReplicas, "replicas", 1, "Specify the number of repliaces in the generate resource spec")

// In order to 'separate' both OpenShift and Kubernetes only flags. A custom help page is created
customHelp := `Usage:{{if .Runnable}}
{{if .HasAvailableFlags}}{{appendIfNotPresent .UseLine "[flags]"}}{{else}}{{.UseLine}}{{end}}{{end}}{{if .HasAvailableSubCommands}}
{{ .CommandPath}} [command]{{end}}{{if gt .Aliases 0}}
Aliases:
{{.NameAndAliases}}
{{end}}{{if .HasExample}}
Examples:
{{ .Example }}{{end}}{{ if .HasAvailableSubCommands}}
Available Commands:{{range .Commands}}{{if .IsAvailableCommand}}
{{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{ if .HasAvailableLocalFlags}}
Resource Flags:
-c, --chart Create a Helm chart for converted objects
--daemon-set Generate a daemonset object
-d, --deployment Generate a deployment object
--deployment-config Generate a deployment config object
--replication-controller Generate a replication controller object
Flags:
{{.LocalFlags.FlagUsages | trimRightSpace}}{{end}}{{ if .HasAvailableInheritedFlags}}
Global Flags:
{{.InheritedFlags.FlagUsages | trimRightSpace}}{{end}}{{if .HasHelpSubCommands}}
Additional help topics:{{range .Commands}}{{if .IsHelpCommand}}
{{rpad .CommandPath .CommandPathPadding}} {{.Short}}{{end}}{{end}}{{end}}{{ if .HasAvailableSubCommands }}
Use "{{.CommandPath}} [command] --help" for more information about a command.{{end}}
`
// Set the help template + add the command to root
convertCmd.SetHelpTemplate(customHelp)

RootCmd.AddCommand(convertCmd)
}
Loading

0 comments on commit 9aa3edf

Please sign in to comment.