Merge pull request #582 from oasisprotocol/kostko/feature/rofl-machine-change-admin

feat(cmd/rofl): Add machine change-admin subcommand

Author: kostko

cmd/common/selector.go

@@ -43,8 +43,9 @@ type NPASelection struct {
 	ParaTimeName string
 	ParaTime     *config.ParaTime
 
-	AccountName string
-	Account     *cliConfig.Account
+	AccountName          string
+	Account              *cliConfig.Account
+	AccountSetExplicitly bool
 }
 
 // GetNPASelection returns the user-selected network/ParaTime/account combination.
@@ -78,6 +79,7 @@ func GetNPASelection(cfg *cliConfig.Config) *NPASelection {
 	s.AccountName = cfg.Wallet.Default
 	if selectedAccount != "" {
 		s.AccountName = selectedAccount
+		s.AccountSetExplicitly = true
 	}
 	if s.AccountName != "" {
 		accCfg, err := LoadAccountConfig(cfg, s.AccountName)

cmd/rofl/common/manifest.go

@@ -2,6 +2,8 @@ package common
 
 import (
 	"fmt"
+	"regexp"
+	"strings"
 
 	"github.com/spf13/cobra"
 
@@ -10,6 +12,14 @@ import (
 	cliConfig "github.com/oasisprotocol/cli/config"
 )
 
+var (
+	// orcFilenameDisallowedChars is a regexp matching characters that are not allowed in filenames.
+	orcFilenameDisallowedChars = regexp.MustCompile("[^a-zA-Z0-9-]")
+
+	// orcFilenameRepeatedChars is a regexp matching repeats of dash characters in filenames.
+	orcFilenameRepeatedChars = regexp.MustCompile("(-){2,}")
+)
+
 // ManifestOptions configures the manifest options.
 type ManifestOptions struct {
 	// NeedAppID specifies whether a configured app ID is required in the manifest.
@@ -76,8 +86,11 @@ func MaybeLoadManifestAndSetNPA(cfg *cliConfig.Config, npa *common.NPASelection,
 		}
 		npa.ParaTimeName = d.ParaTime
 	}
-	switch d.Admin {
-	case "":
+	switch {
+	case d.Admin == "":
+		// No admin in manifest, leave unchanged.
+	case npa.AccountSetExplicitly:
+		// Account explicitly overridden on the command line, leave unchanged.
 	default:
 		accCfg, err := common.LoadAccountConfig(cfg, d.Admin)
 		switch {
@@ -95,5 +108,9 @@ func MaybeLoadManifestAndSetNPA(cfg *cliConfig.Config, npa *common.NPASelection,
 
 // GetOrcFilename generates a filename based on the project name and deployment.
 func GetOrcFilename(manifest *rofl.Manifest, deploymentName string) string {
-	return fmt.Sprintf("%s.%s.orc", manifest.Name, deploymentName)
+	normalizedName := strings.ToLower(manifest.Name)
+	normalizedName = strings.TrimSpace(normalizedName)
+	normalizedName = orcFilenameDisallowedChars.ReplaceAllString(normalizedName, "-")
+	normalizedName = orcFilenameRepeatedChars.ReplaceAllString(normalizedName, "$1")
+	return fmt.Sprintf("%s.%s.orc", normalizedName, deploymentName)
 }

cmd/rofl/common/manifest_test.go

@@ -0,0 +1,27 @@
+package common
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/oasisprotocol/cli/build/rofl"
+)
+
+func TestGetOrcFilename(t *testing.T) {
+	require := require.New(t)
+
+	for _, tc := range []struct {
+		name       string
+		deployment string
+		expected   string
+	}{
+		{"rofl-scheduler", "mainnet", "rofl-scheduler.mainnet.orc"},
+		{"ROFL Scheduler", "mainnet", "rofl-scheduler.mainnet.orc"},
+		{"   This is a    test   ", "mainnet", "this-is-a-test.mainnet.orc"},
+	} {
+		manifest := &rofl.Manifest{Name: tc.name}
+		fn := GetOrcFilename(manifest, "mainnet")
+		require.Equal(tc.expected, fn)
+	}
+}

cmd/rofl/machine/machine.go

@@ -15,6 +15,7 @@ func init() {
 	Cmd.AddCommand(restartCmd)
 	Cmd.AddCommand(stopCmd)
 	Cmd.AddCommand(removeCmd)
+	Cmd.AddCommand(changeAdminCmd)
 	Cmd.AddCommand(topUpCmd)
 	Cmd.AddCommand(logsCmd)
 }

cmd/rofl/machine/mgmt.go

@@ -7,6 +7,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/oasisprotocol/oasis-core/go/common/cbor"
+	"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/modules/rofl"
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/modules/roflmarket"
@@ -110,6 +111,84 @@ var (
 		},
 	}
 
+	changeAdminCmd = &cobra.Command{
+		Use:   "change-admin [<machine-name>] <new-admin>",
+		Short: "Change the machine administrator",
+		Args:  cobra.RangeArgs(1, 2),
+		Run: func(_ *cobra.Command, args []string) {
+			txCfg := common.GetTransactionConfig()
+
+			_, deployment, npa := roflCommon.LoadManifestAndSetNPA(&roflCommon.ManifestOptions{
+				NeedAppID: true,
+				NeedAdmin: false,
+			})
+
+			var newAdminAddress string
+			switch len(args) {
+			case 1:
+				// Just admin address.
+				newAdminAddress = args[0]
+				args = nil
+			case 2:
+				// Machine and admin address.
+				newAdminAddress = args[1]
+				args = args[:1]
+			}
+
+			machine, machineName, machineID := resolveMachine(args, deployment)
+
+			// Resolve provider address.
+			providerAddr, _, err := common.ResolveLocalAccountOrAddress(npa.Network, machine.Provider)
+			if err != nil {
+				cobra.CheckErr(fmt.Sprintf("Invalid provider address: %s", err))
+			}
+
+			// Resolve new admin address.
+			newAdminAddr, _, err := common.ResolveLocalAccountOrAddress(npa.Network, newAdminAddress)
+			if err != nil {
+				cobra.CheckErr(fmt.Sprintf("Invalid admin address: %s", err))
+			}
+
+			// When not in offline mode, connect to the given network endpoint.
+			ctx := context.Background()
+			var conn connection.Connection
+			if !txCfg.Offline {
+				conn, err = connection.Connect(ctx, npa.Network)
+				cobra.CheckErr(err)
+			}
+
+			fmt.Printf("Provider:  %s (%s)\n", machine.Provider, providerAddr)
+			fmt.Printf("Machine:   %s [%s]\n", machineName, machine.ID)
+
+			// Resolve old admin in online mode.
+			if !txCfg.Offline {
+				insDsc, err := conn.Runtime(npa.ParaTime).ROFLMarket.Instance(ctx, client.RoundLatest, *providerAddr, machineID)
+				cobra.CheckErr(err)
+
+				fmt.Printf("Old admin: %s\n", insDsc.Admin)
+			}
+
+			fmt.Printf("New admin: %s\n", newAdminAddr)
+
+			// Prepare transaction.
+			tx := roflmarket.NewInstanceChangeAdmin(nil, &roflmarket.InstanceChangeAdmin{
+				Provider: *providerAddr,
+				ID:       machineID,
+				Admin:    *newAdminAddr,
+			})
+
+			acc := common.LoadAccount(cliConfig.Global(), npa.AccountName)
+			sigTx, meta, err := common.SignParaTimeTransaction(ctx, npa, acc, conn, tx, nil)
+			cobra.CheckErr(err)
+
+			if !common.BroadcastOrExportTransaction(ctx, npa, conn, sigTx, meta, nil) {
+				return
+			}
+
+			fmt.Printf("Machine admin address changed.\n")
+		},
+	}
+
 	topUpCmd = &cobra.Command{
 		Use:   "top-up [<machine-name>]",
 		Short: "Top-up payment for a machine",
@@ -284,6 +363,10 @@ func init() {
 	removeCmd.Flags().AddFlagSet(common.RuntimeTxFlags)
 	removeCmd.Flags().AddFlagSet(roflCommon.DeploymentFlags)
 
+	changeAdminCmd.Flags().AddFlagSet(common.AccountFlag)
+	changeAdminCmd.Flags().AddFlagSet(common.RuntimeTxFlags)
+	changeAdminCmd.Flags().AddFlagSet(roflCommon.DeploymentFlags)
+
 	topUpCmd.Flags().AddFlagSet(common.SelectorFlags)
 	topUpCmd.Flags().AddFlagSet(common.RuntimeTxFlags)
 	topUpCmd.Flags().AddFlagSet(roflCommon.DeploymentFlags)

cmd/rofl/mgmt.go

@@ -13,7 +13,6 @@ import (
 	"sort"
 
 	"github.com/spf13/cobra"
-	flag "github.com/spf13/pflag"
 
 	"github.com/oasisprotocol/oasis-core/go/common/sgx/pcs"
 	"github.com/oasisprotocol/oasis-core/go/common/sgx/quote"
@@ -37,9 +36,8 @@ var (
 		"cn":  rofl.CreatorNonce,
 	}
 
-	scheme       string
-	adminAddress string
-	pubName      string
+	scheme  string
+	pubName string
 
 	appTEE  string
 	appKind string
@@ -302,9 +300,6 @@ var (
 				NeedAdmin: true,
 			})
 
-			if adminAddress == "" && deployment.Admin != "" {
-				adminAddress = "self"
-			}
 			secrets := buildRofl.PrepareSecrets(deployment.Secrets)
 
 			var appID rofl.AppID
@@ -315,10 +310,6 @@ var (
 			npa.MustHaveAccount()
 			npa.MustHaveParaTime()
 
-			if adminAddress == "" {
-				fmt.Println("You must specify --admin or configure an admin in the manifest.")
-				return
-			}
 			if deployment.Policy == nil {
 				fmt.Println("You must configure policy in the manifest.")
 				return
@@ -341,11 +332,8 @@ var (
 			}
 
 			// Update administrator address.
-			if adminAddress == "self" {
-				adminAddress = npa.AccountName
-			}
 			var err error
-			updateBody.Admin, _, err = common.ResolveLocalAccountOrAddress(npa.Network, adminAddress)
+			updateBody.Admin, _, err = common.ResolveLocalAccountOrAddress(npa.Network, deployment.Admin)
 			if err != nil {
 				cobra.CheckErr(fmt.Errorf("bad administrator address: %w", err))
 			}
@@ -819,10 +807,6 @@ func detectOrCreateComposeFile() string {
 }
 
 func init() {
-	updateFlags := flag.NewFlagSet("", flag.ContinueOnError)
-	updateFlags.StringVar(&adminAddress, "admin", "", "set the administrator address")
-	updateCmd.Flags().AddFlagSet(roflCommon.DeploymentFlags)
-
 	initCmd.Flags().StringVar(&appTEE, "tee", "tdx", "TEE kind [tdx, sgx]")
 	initCmd.Flags().StringVar(&appKind, "kind", "container", "ROFL app kind [container, raw]")
 
@@ -832,10 +816,9 @@ func init() {
 	createCmd.Flags().AddFlagSet(roflCommon.NoUpdateFlag)
 	createCmd.Flags().StringVar(&scheme, "scheme", "cn", "app ID generation scheme: creator+round+index [cri] or creator+nonce [cn]")
 
-	updateCmd.Flags().AddFlagSet(common.SelectorFlags)
+	updateCmd.Flags().AddFlagSet(common.AccountFlag)
 	updateCmd.Flags().AddFlagSet(common.RuntimeTxFlags)
 	updateCmd.Flags().AddFlagSet(roflCommon.DeploymentFlags)
-	updateCmd.Flags().AddFlagSet(updateFlags)
 
 	removeCmd.Flags().AddFlagSet(common.SelectorFlags)
 	removeCmd.Flags().AddFlagSet(common.RuntimeTxFlags)