Merge pull request #514 from oasisprotocol/matevz/feature/rofl-flags-cleanup

cmd/rofl: Revamp common rofl flags

Author: matevz

cmd/rofl/build/build.go

@@ -21,7 +21,6 @@ import (
 	buildRofl "github.com/oasisprotocol/cli/build/rofl"
 	"github.com/oasisprotocol/cli/cmd/common"
 	roflCommon "github.com/oasisprotocol/cli/cmd/rofl/common"
-	cliConfig "github.com/oasisprotocol/cli/config"
 )
 
 // Build modes.
@@ -31,24 +30,21 @@ const (
 )
 
 var (
-	outputFn       string
-	buildMode      string
-	offline        bool
-	noUpdate       bool
-	doVerify       bool
-	deploymentName string
-	noDocker       bool
-	onlyValidate   bool
+	outputFn     string
+	buildMode    string
+	offline      bool
+	noUpdate     bool
+	doVerify     bool
+	noDocker     bool
+	onlyValidate bool
 
 	Cmd = &cobra.Command{
 		Use:   "build",
 		Short: "Build a ROFL application",
 		Args:  cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			cmd.SilenceUsage = true
-			cfg := cliConfig.Global()
-			npa := common.GetNPASelection(cfg)
-			manifest, deployment := roflCommon.LoadManifestAndSetNPA(cfg, npa, deploymentName, &roflCommon.ManifestOptions{
+			manifest, deployment, npa := roflCommon.LoadManifestAndSetNPA(&roflCommon.ManifestOptions{
 				NeedAppID: true,
 				NeedAdmin: false,
 			})
@@ -64,7 +60,7 @@ var (
 			}
 
 			fmt.Println("Building a ROFL application...")
-			fmt.Printf("Deployment: %s\n", deploymentName)
+			fmt.Printf("Deployment: %s\n", roflCommon.DeploymentName)
 			fmt.Printf("Network:    %s\n", deployment.Network)
 			fmt.Printf("ParaTime:   %s\n", deployment.ParaTime)
 			fmt.Printf("Debug:      %v\n", deployment.Debug)
@@ -124,7 +120,7 @@ var (
 
 			// Setup some build environment variables.
 			os.Setenv("ROFL_MANIFEST", manifest.SourceFileName())
-			os.Setenv("ROFL_DEPLOYMENT_NAME", deploymentName)
+			os.Setenv("ROFL_DEPLOYMENT_NAME", roflCommon.DeploymentName)
 			os.Setenv("ROFL_DEPLOYMENT_NETWORK", deployment.Network)
 			os.Setenv("ROFL_DEPLOYMENT_PARATIME", deployment.ParaTime)
 			os.Setenv("ROFL_TMPDIR", tmpDir)
@@ -157,7 +153,7 @@ var (
 			runScript(manifest, buildRofl.ScriptBuildPost)
 
 			// Write the bundle out.
-			outFn := roflCommon.GetOrcFilename(manifest, deploymentName)
+			outFn := roflCommon.GetOrcFilename(manifest, roflCommon.DeploymentName)
 			if outputFn != "" {
 				outFn = outputFn
 			}
@@ -260,7 +256,7 @@ var (
 				fmt.Println("Update the manifest with the following identities to use the new app:")
 				fmt.Println()
 				fmt.Printf("deployments:\n")
-				fmt.Printf("  %s:\n", deploymentName)
+				fmt.Printf("  %s:\n", roflCommon.DeploymentName)
 				fmt.Printf("    policy:\n")
 				fmt.Printf("      enclaves:\n")
 				for _, id := range ids {
@@ -366,10 +362,11 @@ func init() {
 	buildFlags.StringVar(&outputFn, "output", "", "output bundle filename")
 	buildFlags.BoolVar(&noUpdate, "no-update-manifest", false, "do not update the manifest")
 	buildFlags.BoolVar(&doVerify, "verify", false, "verify build against manifest and on-chain state")
-	buildFlags.StringVar(&deploymentName, "deployment", buildRofl.DefaultDeploymentName, "deployment name")
 	buildFlags.BoolVar(&noDocker, "no-docker", false, "do not use the Dockerized builder")
 	buildFlags.BoolVar(&onlyValidate, "only-validate", false, "validate without building")
 
+	buildFlags.AddFlagSet(roflCommon.DeploymentFlags)
+
 	// TODO: Remove when all the examples, demos and docs are updated.
 	var dummy bool
 	buildFlags.BoolVar(&dummy, "update-manifest", true, "not update the manifest")

cmd/rofl/common/flags.go

@@ -0,0 +1,29 @@
+package common
+
+import (
+	flag "github.com/spf13/pflag"
+
+	buildRofl "github.com/oasisprotocol/cli/build/rofl"
+)
+
+var (
+	// WipeFlags is the flag for wiping the machine storage on deployment/restart.
+	WipeFlags *flag.FlagSet
+
+	// DeploymentFlags provide the deployment name.
+	DeploymentFlags *flag.FlagSet
+
+	// DeploymentName is the name of the ROFL app deployment.
+	DeploymentName string
+
+	// WipeStorage enables wiping the machine storage on deployment/restart.
+	WipeStorage bool
+)
+
+func init() {
+	WipeFlags = flag.NewFlagSet("", flag.ContinueOnError)
+	WipeFlags.BoolVar(&WipeStorage, "wipe-storage", false, "whether to wipe machine storage")
+
+	DeploymentFlags = flag.NewFlagSet("", flag.ContinueOnError)
+	DeploymentFlags.StringVar(&DeploymentName, "deployment", buildRofl.DefaultDeploymentName, "deployment name")
+}

cmd/rofl/common/manifest.go

@@ -7,7 +7,7 @@ import (
 
 	"github.com/oasisprotocol/cli/build/rofl"
 	"github.com/oasisprotocol/cli/cmd/common"
-	"github.com/oasisprotocol/cli/config"
+	cliConfig "github.com/oasisprotocol/cli/config"
 )
 
 // ManifestOptions configures the manifest options.
@@ -23,20 +23,23 @@ type ManifestOptions struct {
 // selection.
 //
 // In case there is an error in loading the manifest, it aborts the application.
-func LoadManifestAndSetNPA(cfg *config.Config, npa *common.NPASelection, deployment string, opts *ManifestOptions) (*rofl.Manifest, *rofl.Deployment) {
-	manifest, d, err := MaybeLoadManifestAndSetNPA(cfg, npa, deployment, opts)
+func LoadManifestAndSetNPA(opts *ManifestOptions) (*rofl.Manifest, *rofl.Deployment, *common.NPASelection) {
+	cfg := cliConfig.Global()
+	npa := common.GetNPASelection(cfg)
+
+	manifest, d, err := MaybeLoadManifestAndSetNPA(cfg, npa, DeploymentName, opts)
 	cobra.CheckErr(err)
 	if opts != nil && opts.NeedAppID && !d.HasAppID() {
-		cobra.CheckErr(fmt.Errorf("deployment '%s' does not have an app ID set, maybe you need to run `oasis rofl create`", deployment))
+		cobra.CheckErr(fmt.Errorf("deployment '%s' does not have an app ID set, maybe you need to run `oasis rofl create`", DeploymentName))
 	}
-	return manifest, d
+	return manifest, d, npa
 }
 
 // MaybeLoadManifestAndSetNPA loads the ROFL app manifest and reconfigures the
 // network/paratime/account selection.
 //
 // In case there is an error in loading the manifest, it is returned.
-func MaybeLoadManifestAndSetNPA(cfg *config.Config, npa *common.NPASelection, deployment string, opts *ManifestOptions) (*rofl.Manifest, *rofl.Deployment, error) {
+func MaybeLoadManifestAndSetNPA(cfg *cliConfig.Config, npa *common.NPASelection, deployment string, opts *ManifestOptions) (*rofl.Manifest, *rofl.Deployment, error) {
 	manifest, err := rofl.LoadManifest()
 	if err != nil {
 		return nil, nil, err

cmd/rofl/deploy.go

@@ -49,15 +49,13 @@ var (
 		Short: "Deploy ROFL to a specified machine",
 		Args:  cobra.NoArgs,
 		Run: func(_ *cobra.Command, _ []string) {
-			cfg := cliConfig.Global()
-			npa := common.GetNPASelection(cfg)
 			txCfg := common.GetTransactionConfig()
 
 			if txCfg.Offline {
 				cobra.CheckErr("offline mode currently not supported")
 			}
 
-			manifest, deployment := roflCommon.LoadManifestAndSetNPA(cfg, npa, deploymentName, &roflCommon.ManifestOptions{
+			manifest, deployment, npa := roflCommon.LoadManifestAndSetNPA(&roflCommon.ManifestOptions{
 				NeedAppID: true,
 				NeedAdmin: true,
 			})
@@ -105,15 +103,15 @@ var (
 					if roflServices, ok := provider.DefaultRoflServices[npa.ParaTime.ID]; ok {
 						deployProvider = roflServices.Provider
 					} else {
-						cobra.CheckErr(fmt.Sprintf("Provider not configured for deployment '%s' machine '%s'. Please specify --provider.", deploymentName, deployMachine))
+						cobra.CheckErr(fmt.Sprintf("Provider not configured for deployment '%s' machine '%s'. Please specify --provider.", roflCommon.DeploymentName, deployMachine))
 					}
 				}
 
 				machine.Provider = deployProvider
 			default:
 				// Already set, require the provider to be omitted or equal.
 				if deployProvider != "" && deployProvider != machine.Provider {
-					cobra.CheckErr(fmt.Sprintf("Provider '%s' conflicts with existing provider '%s' for deployment '%s' machine '%s'. Omit --provider.", deployProvider, machine.Provider, deploymentName, deployMachine))
+					cobra.CheckErr(fmt.Sprintf("Provider '%s' conflicts with existing provider '%s' for deployment '%s' machine '%s'. Omit --provider.", deployProvider, machine.Provider, roflCommon.DeploymentName, deployMachine))
 				}
 			}
 
@@ -132,7 +130,7 @@ var (
 			}
 
 			ociRepository := ociRepository(deployment)
-			orcFilename := roflCommon.GetOrcFilename(manifest, deploymentName)
+			orcFilename := roflCommon.GetOrcFilename(manifest, roflCommon.DeploymentName)
 			fmt.Printf("Pushing ROFL app to OCI repository '%s'...\n", ociRepository)
 			ociDigest, manifestHash := pushBundleToOciRepository(orcFilename, ociRepository)
 			// Save the OCI repository field to the configuration file so we avoid multiple uploads.
@@ -200,7 +198,7 @@ var (
 					TermCount:  deployTermCount,
 				})
 
-				acc := common.LoadAccount(cfg, npa.AccountName)
+				acc := common.LoadAccount(cliConfig.Global(), npa.AccountName)
 				var sigTx, meta any
 				sigTx, meta, err = common.SignParaTimeTransaction(ctx, npa, acc, conn, tx, nil)
 				cobra.CheckErr(err)
@@ -260,12 +258,12 @@ var (
 						Method: scheduler.MethodDeploy,
 						Args: cbor.Marshal(scheduler.DeployRequest{
 							Deployment:  machineDeployment,
-							WipeStorage: false,
+							WipeStorage: roflCommon.WipeStorage,
 						}),
 					})},
 				})
 
-				acc := common.LoadAccount(cfg, npa.AccountName)
+				acc := common.LoadAccount(cliConfig.Global(), npa.AccountName)
 				var sigTx, meta any
 				sigTx, meta, err = common.SignParaTimeTransaction(ctx, npa, acc, conn, tx, nil)
 				cobra.CheckErr(err)
@@ -455,8 +453,8 @@ func init() {
 	providerFlags.BoolVar(&deployShowOffers, "show-offers", false, "show all provider offers and quit")
 	providerFlags.BoolVar(&deployReplaceMachine, "replace-machine", false, "rent a new machine if the provided one expired")
 
-	deployCmd.Flags().AddFlagSet(common.SelectorFlags)
 	deployCmd.Flags().AddFlagSet(common.RuntimeTxFlags)
-	deployCmd.Flags().AddFlagSet(deploymentFlags)
 	deployCmd.Flags().AddFlagSet(providerFlags)
+	deployCmd.Flags().AddFlagSet(roflCommon.DeploymentFlags)
+	deployCmd.Flags().AddFlagSet(roflCommon.WipeFlags)
 }

cmd/rofl/machine/logs.go

@@ -6,15 +6,13 @@ import (
 	"time"
 
 	"github.com/spf13/cobra"
-	flag "github.com/spf13/pflag"
 
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/client"
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/connection"
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/crypto/signature"
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/crypto/signature/ed25519"
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/types"
 
-	buildRofl "github.com/oasisprotocol/cli/build/rofl"
 	"github.com/oasisprotocol/cli/build/rofl/scheduler"
 	"github.com/oasisprotocol/cli/cmd/common"
 	roflCommon "github.com/oasisprotocol/cli/cmd/rofl/common"
@@ -26,10 +24,7 @@ var logsCmd = &cobra.Command{
 	Short: "Show logs from the given machine",
 	Args:  cobra.MaximumNArgs(1),
 	Run: func(_ *cobra.Command, args []string) {
-		cfg := cliConfig.Global()
-		npa := common.GetNPASelection(cfg)
-
-		_, deployment := roflCommon.LoadManifestAndSetNPA(cfg, npa, deploymentName, &roflCommon.ManifestOptions{
+		_, deployment, npa := roflCommon.LoadManifestAndSetNPA(&roflCommon.ManifestOptions{
 			NeedAppID: true,
 			NeedAdmin: false,
 		})
@@ -70,7 +65,7 @@ var logsCmd = &cobra.Command{
 		cobra.CheckErr(err)
 
 		// TODO: Cache authentication token so we don't need to re-authenticate.
-		acc := common.LoadAccount(cfg, npa.AccountName)
+		acc := common.LoadAccount(cliConfig.Global(), npa.AccountName)
 
 		sigCtx := &signature.RichContext{
 			RuntimeID:    npa.ParaTime.Namespace(),
@@ -92,9 +87,6 @@ var logsCmd = &cobra.Command{
 }
 
 func init() {
-	deploymentFlags := flag.NewFlagSet("", flag.ContinueOnError)
-	deploymentFlags.StringVar(&deploymentName, "deployment", buildRofl.DefaultDeploymentName, "deployment name")
-
-	logsCmd.Flags().AddFlagSet(deploymentFlags)
+	logsCmd.Flags().AddFlagSet(roflCommon.DeploymentFlags)
 	logsCmd.Flags().AddFlagSet(common.AnswerYesFlag)
 }