feat(cmd/rofl): Move debug flag to manifest

Author: kostko

build/rofl/manifest.go

@@ -187,6 +187,8 @@ type Deployment struct {
 	ParaTime string `yaml:"paratime" json:"paratime"`
 	// Admin is the identifier of the admin account.
 	Admin string `yaml:"admin,omitempty" json:"admin,omitempty"`
+	// Debug is a flag denoting whether this is a debuggable deployment.
+	Debug bool `yaml:"debug,omitempty" json:"debug,omitempty"`
 	// TrustRoot is the optional trust root configuration.
 	TrustRoot *TrustRootConfig `yaml:"trust_root,omitempty" json:"trust_root,omitempty"`
 	// Policy is the ROFL app policy.

cmd/rofl/build/build.go

@@ -13,7 +13,6 @@ import (
 	"github.com/oasisprotocol/oasis-core/go/common/cbor"
 	"github.com/oasisprotocol/oasis-core/go/common/sgx"
 	"github.com/oasisprotocol/oasis-core/go/common/version"
-	consensus "github.com/oasisprotocol/oasis-core/go/consensus/api"
 	"github.com/oasisprotocol/oasis-core/go/runtime/bundle"
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/connection"
 
@@ -27,7 +26,6 @@ import (
 const (
 	buildModeProduction = "production"
 	buildModeUnsafe     = "unsafe"
-	buildModeAuto       = "auto"
 )
 
 var (
@@ -50,12 +48,20 @@ var (
 			fmt.Printf("Deployment: %s\n", deploymentName)
 			fmt.Printf("Network:    %s\n", deployment.Network)
 			fmt.Printf("ParaTime:   %s\n", deployment.ParaTime)
+			fmt.Printf("Debug:      %v\n", deployment.Debug)
 			fmt.Printf("App ID:     %s\n", deployment.AppID)
 			fmt.Printf("Name:       %s\n", manifest.Name)
 			fmt.Printf("Version:    %s\n", manifest.Version)
 			fmt.Printf("TEE:        %s\n", manifest.TEE)
 			fmt.Printf("Kind:       %s\n", manifest.Kind)
 
+			switch deployment.Debug {
+			case true:
+				buildMode = buildModeUnsafe
+			case false:
+				buildMode = buildModeProduction
+			}
+
 			// Prepare temporary build directory.
 			tmpDir, err := os.MkdirTemp("", "oasis-build")
 			if err != nil {
@@ -171,29 +177,6 @@ var (
 	}
 )
 
-func detectBuildMode(npa *common.NPASelection) {
-	// Configure build mode. In case auto is selected and not offline, query the network. If
-	// autodetection fails, default to production mode.
-	switch {
-	case buildMode == buildModeAuto && !offline:
-		ctx := context.Background()
-		conn, err := connection.Connect(ctx, npa.Network)
-		if err != nil {
-			cobra.CheckErr(fmt.Errorf("unable to autodetect build mode, please provide --mode flag manually (failed to connect to GRPC endpoint: %w)", err))
-		}
-
-		params, err := conn.Consensus().Registry().ConsensusParameters(ctx, consensus.HeightLatest)
-		if err != nil {
-			cobra.CheckErr(fmt.Errorf("unable to autodetect build mode, please provide --mode flag manually (failed to get consensus parameters: %w)", err))
-		}
-
-		if params.DebugAllowTestRuntimes {
-			buildMode = buildModeUnsafe
-		}
-	default:
-	}
-}
-
 func setupBuildEnv(deployment *buildRofl.Deployment, npa *common.NPASelection) {
 	// Configure app ID.
 	os.Setenv("ROFL_APP_ID", deployment.AppID)
@@ -267,7 +250,6 @@ func fetchTrustRoot(npa *common.NPASelection, cfg *buildRofl.TrustRootConfig) (s
 
 func init() {
 	buildFlags := flag.NewFlagSet("", flag.ContinueOnError)
-	buildFlags.StringVar(&buildMode, "mode", "auto", "build mode [production, unsafe, auto]")
 	buildFlags.BoolVar(&offline, "offline", false, "do not perform any operations requiring network access")
 	buildFlags.StringVar(&outputFn, "output", "", "output bundle filename")
 	buildFlags.BoolVar(&doUpdate, "update-manifest", false, "automatically update the manifest")

cmd/rofl/build/container.go

@@ -45,7 +45,6 @@ func tdxBuildContainer(
 	)
 	tdxOverrideArtifacts(manifest, wantedArtifacts)
 	artifacts := tdxFetchArtifacts(wantedArtifacts)
-	detectBuildMode(npa)
 
 	// Use the pre-built container runtime.
 	initPath := artifacts[artifactContainerRuntime]

cmd/rofl/build/sgx.go

@@ -32,7 +32,6 @@ func sgxBuild(
 ) {
 	fmt.Println("Building an SGX-based Rust ROFL application...")
 
-	detectBuildMode(npa)
 	features := sgxSetupBuildEnv(deployment, npa)
 
 	// First build for the default target.
@@ -218,7 +217,7 @@ func sgxSetupBuildEnv(deployment *buildRofl.Deployment, npa *common.NPASelection
 	setupBuildEnv(deployment, npa)
 
 	switch buildMode {
-	case buildModeProduction, buildModeAuto:
+	case buildModeProduction:
 		// Production builds.
 		fmt.Println("Building in production mode.")
 

cmd/rofl/build/tdx.go

@@ -47,7 +47,6 @@ func tdxBuildRaw(
 
 	fmt.Println("Building a TDX-based Rust ROFL application...")
 
-	detectBuildMode(npa)
 	tdxSetupBuildEnv(deployment, npa)
 
 	// Obtain package metadata.
@@ -308,7 +307,7 @@ func tdxSetupBuildEnv(deployment *buildRofl.Deployment, npa *common.NPASelection
 	setupBuildEnv(deployment, npa)
 
 	switch buildMode {
-	case buildModeProduction, buildModeAuto:
+	case buildModeProduction:
 		// Production builds.
 		fmt.Println("Building in production mode.")
 

cmd/rofl/mgmt.go

@@ -83,11 +83,19 @@ var (
 			height, err := common.GetActualHeight(ctx, conn.Consensus())
 			cobra.CheckErr(err)
 
+			// Determine debug mode.
+			var debugMode bool
+			params, err := conn.Consensus().Registry().ConsensusParameters(ctx, height)
+			if err == nil {
+				debugMode = params.DebugAllowTestRuntimes
+			}
+
 			// Generate manifest and a default policy which does not accept any enclaves.
 			deployment := &buildRofl.Deployment{
 				Network:  npa.NetworkName,
 				ParaTime: npa.ParaTimeName,
 				Admin:    npa.AccountName,
+				Debug:    debugMode,
 				Policy: &rofl.AppAuthPolicy{
 					Quotes: quote.Policy{
 						PCS: &pcs.QuotePolicy{
@@ -134,6 +142,7 @@ var (
 			fmt.Printf("Deployment '%s':\n", buildRofl.DefaultDeploymentName)
 			fmt.Printf("  Network:  %s\n", deployment.Network)
 			fmt.Printf("  ParaTime: %s\n", deployment.ParaTime)
+			fmt.Printf("  Debug:    %v\n", deployment.Debug)
 			fmt.Printf("  Admin:    %s\n", deployment.Admin)
 
 			// Serialize manifest and write it to file.