feat: add json support to config dump --format (#405)

* add json support to config dump

* switch json marshalling to camelCase

* make config dump command work as root

* add comments explaining why we allow dump to be run as root

Author: tobiasb-ms

.golangci.yml

@@ -163,7 +163,7 @@ linters:
     tagliatelle:
       case:
         rules:
-          json: goPascal
+          json: camel
 
     varnamelen:
       ignore-decls:

internal/app/azldev/cmds/component/build.go

@@ -33,13 +33,13 @@ type ComponentBuildOptions struct {
 // ComponentBuildResults summarizes the results of building a single component.
 type ComponentBuildResults struct {
 	// Names of the component that was built.
-	ComponentName string `json:"ComponentName"`
+	ComponentName string `json:"componentName"`
 
 	// Absolute paths to any source RPMs built by the operation.
-	SRPMPaths []string `json:"SrpmPaths" table:"SRPM Paths"`
+	SRPMPaths []string `json:"srpmPaths" table:"SRPM Paths"`
 
 	// Absolute paths to any RPMs built by the operation.
-	RPMPaths []string `json:"RpmPaths" table:"RPM Paths"`
+	RPMPaths []string `json:"rpmPaths" table:"RPM Paths"`
 }
 
 func buildOnAppInit(_ *azldev.App, parent *cobra.Command) {

internal/app/azldev/cmds/config/dump.go

@@ -4,6 +4,7 @@
 package config
 
 import (
+	"encoding/json"
 	"fmt"
 
 	"github.com/gim-home/azldev-preview/internal/app/azldev"
@@ -16,6 +17,7 @@ type configDumpFormat string
 
 const (
 	ConfigDumpFormatTOML configDumpFormat = "toml"
+	ConfigDumpFormatJSON configDumpFormat = "json"
 )
 
 // Assert that ConfigDumpFormat implements the [pflag.Value] interface.
@@ -30,6 +32,8 @@ func (f *configDumpFormat) Set(value string) error {
 	switch value {
 	case "toml":
 		*f = ConfigDumpFormatTOML
+	case "json":
+		*f = ConfigDumpFormatJSON
 	default:
 		return fmt.Errorf("unsupported format: %#q", value)
 	}
@@ -63,9 +67,15 @@ func newDumpCmd() *cobra.Command {
 
 			return "", nil
 		}),
+		// Allowing 'config dump' to be run as root for two reasons:
+		// 1. It doesn't modify anything -- even as root it's safe.
+		// 2. There are container-based scenarios where the default user is root.
+		Annotations: map[string]string{
+			azldev.CommandAnnotationRootOK: "true",
+		},
 	}
 
-	cmd.Flags().VarP(&configDumpFormat, "format", "f", "Output format")
+	cmd.Flags().VarP(&configDumpFormat, "format", "f", "Output format {json, toml}")
 
 	azldev.ExportAsMCPTool(cmd)
 
@@ -81,6 +91,13 @@ func DumpConfig(env *azldev.Env, format configDumpFormat) (string, error) {
 		}
 
 		return string(tomlBytes), nil
+	case ConfigDumpFormatJSON:
+		jsonBytes, err := json.MarshalIndent(env.Config(), "", "  ")
+		if err != nil {
+			return "", fmt.Errorf("failed to serialize config to JSON:\n%w", err)
+		}
+
+		return string(jsonBytes), nil
 	default:
 		return "", fmt.Errorf("unsupported format: %#q", format)
 	}

internal/app/azldev/cmds/config/dump_test.go

@@ -47,4 +47,8 @@ func TestDumpConfig(t *testing.T) {
 	configText, err := config.DumpConfig(env, config.ConfigDumpFormatTOML)
 	require.NoError(t, err)
 	require.NotEmpty(t, configText)
+
+	configText, err = config.DumpConfig(env, config.ConfigDumpFormatJSON)
+	require.NoError(t, err)
+	require.NotEmpty(t, configText)
 }

internal/app/azldev/cmds/version/version.go

@@ -17,14 +17,14 @@ func OnAppInit(app *azldev.App) {
 
 // VersionInfo represents the version information structure.
 type VersionInfo struct {
-	Version    string `json:"Version"`
-	GitCommit  string `json:"GitCommit"`
-	GoVersion  string `json:"GoVersion"`
-	Platform   string `json:"Platform"`
-	Compiler   string `json:"Compiler"`
-	BuildDate  string `json:"BuildDate"`
-	CommitDate string `json:"CommitDate"`
-	DirtyBuild bool   `json:"DirtyBuild"`
+	Version    string `json:"version"`
+	GitCommit  string `json:"gitCommit"`
+	GoVersion  string `json:"goVersion"`
+	Platform   string `json:"platform"`
+	Compiler   string `json:"compiler"`
+	BuildDate  string `json:"buildDate"`
+	CommitDate string `json:"commitDate"`
+	DirtyBuild bool   `json:"dirtyBuild"`
 }
 
 // NewVersionCmd creates a custom version command that respects the global -O flag.

internal/app/azldev/cmds/version/version_test.go

@@ -41,14 +41,14 @@ func TestVersionCmd_JSONOutput(t *testing.T) {
 
 	// Verify JSON output
 	output := reportOutput.String()
-	assert.Contains(t, output, `"Version"`)
-	assert.Contains(t, output, `"GitCommit"`)
-	assert.Contains(t, output, `"GoVersion"`)
-	assert.Contains(t, output, `"Platform"`)
-	assert.Contains(t, output, `"Compiler"`)
-	assert.Contains(t, output, `"BuildDate"`)
-	assert.Contains(t, output, `"CommitDate"`)
-	assert.Contains(t, output, `"DirtyBuild"`)
+	assert.Contains(t, output, `"version"`)
+	assert.Contains(t, output, `"gitCommit"`)
+	assert.Contains(t, output, `"goVersion"`)
+	assert.Contains(t, output, `"platform"`)
+	assert.Contains(t, output, `"compiler"`)
+	assert.Contains(t, output, `"buildDate"`)
+	assert.Contains(t, output, `"commitDate"`)
+	assert.Contains(t, output, `"dirtyBuild"`)
 }
 
 func TestGetVersionInfo(t *testing.T) {

internal/buildenv/buildenv.go

@@ -110,25 +110,25 @@ func (f *EnvType) Type() string {
 // BuildEnvInfo is a simple data structure that contains information about a [BuildEnv].
 type BuildEnvInfo struct {
 	// Name is the human-readable name moniker for the build environment.
-	Name string `json:"Name"`
+	Name string `json:"name"`
 
 	// UserCreated indicates whether the build environment was created on behalf of a direct user request.
 	// If this is false, the build environment was created automatically as part of a larger operation.
-	UserCreated bool `json:"UserCreated"`
+	UserCreated bool `json:"userCreated"`
 
 	// Type is the type of build environment. This is used to determine which technology can be used
 	// to interact with the build environment.
-	Type EnvType `json:"Type"`
+	Type EnvType `json:"type"`
 
 	// CreationTime is the time when the build environment was created. This can be useful for users to
 	// better understanding their environments.
-	CreationTime time.Time `json:"CreationTime"`
+	CreationTime time.Time `json:"creationTime"`
 
 	// Dir is the directory under which the build environment's files are stored.
-	Dir string `json:"Dir"`
+	Dir string `json:"dir"`
 
 	// Description optionally provides a human-readable description of the environment's purpose.
-	Description string `json:"Description"`
+	Description string `json:"description"`
 }
 
 func (i *BuildEnvInfo) Serialize() (data []byte, err error) {

internal/projectconfig/build.go

@@ -7,9 +7,9 @@ package projectconfig
 // or prepare the sources for a component are out of scope.
 type ComponentBuildConfig struct {
 	// Which features should be enabled via `with` options to the builder.
-	With []string `toml:"with,omitempty" json:",omitempty" jsonschema:"title=With options,description='with' options to pass to the builder."`
+	With []string `toml:"with,omitempty" json:"with,omitempty" jsonschema:"title=With options,description='with' options to pass to the builder."`
 	// Which features should be disabled via `without` options to the builder.
-	Without []string `toml:"without,omitempty" json:",omitempty" jsonschema:"title=Without options,description='without' options to pass to the builder."`
+	Without []string `toml:"without,omitempty" json:"without,omitempty" jsonschema:"title=Without options,description='without' options to pass to the builder."`
 	// Macro definitions.
-	Defines map[string]string `toml:"defines,omitempty" json:",omitempty" jsonschema:"title=Macro definitions,description=Macro definitions to pass to the builder."`
+	Defines map[string]string `toml:"defines,omitempty" json:"defines,omitempty" jsonschema:"title=Macro definitions,description=Macro definitions to pass to the builder."`
 }

internal/projectconfig/component.go

@@ -43,21 +43,21 @@ const (
 // Origin represents a single source location with its type and configuration.
 type Origin struct {
 	// Type of source: "url", "github", "local", "blobstore"
-	Type OriginType `toml:"Type" json:"Type"`
+	Type OriginType `toml:"Type" json:"type"`
 
 	// Location - interpretation depends on Type:
 	// - "url": the full URL
 	// - "local": relative or absolute path
-	Location string `toml:"Location,omitempty" json:"Location,omitempty"`
+	Location string `toml:"Location,omitempty" json:"location,omitempty"`
 
 	// Optional: Script for generated files
-	Script string `toml:"Script,omitempty" json:"Script,omitempty"`
+	Script string `toml:"Script,omitempty" json:"script,omitempty"`
 
 	// Optional: Additional arguments specific to the origin type
 	// Examples:
 	// - GitHub: {"release": "v1.2.3", "asset": "foo.tar.gz"}
 	// - Generated: {"arg1": "value1", "arg2": "value2"} (passed as --arg1=value1)
-	Args []string `toml:"Args,omitempty" json:"Args,omitempty"`
+	Args []string `toml:"Args,omitempty" json:"args,omitempty"`
 }
 
 // SourceFileReference encapsulates a reference to a specific source file artifact.
@@ -69,13 +69,13 @@ type SourceFileReference struct {
 	Filename string `toml:"-" json:"-"`
 
 	// Hash of the source file, expressed as a hex string.
-	Hash string `toml:"Hash,omitempty" json:"Hash,omitempty"`
+	Hash string `toml:"Hash,omitempty" json:"hash,omitempty"`
 
 	// Type of hash used by `Hash` (if present).
-	HashType fileutils.HashType `toml:"HashType,omitempty" json:"HashType,omitempty"`
+	HashType fileutils.HashType `toml:"HashType,omitempty" json:"hashType,omitempty"`
 
 	// Ordered list of source origins to try in priority order
-	Origins []Origin `toml:"Origins,omitempty" json:"Origins,omitempty"`
+	Origins []Origin `toml:"Origins,omitempty" json:"origins,omitempty"`
 }
 
 // Defines a component group. Component groups are logical groupings of components (see [ComponentConfig]).
@@ -84,9 +84,9 @@ type SourceFileReference struct {
 // component may belong to multiple groups, and components need not belong to any group.
 type ComponentGroupConfig struct {
 	// List of glob patterns specifying raw spec files that define components.
-	SpecPathPatterns []string `toml:"specs,omitempty" validate:"dive,required" jsonschema:"title=Spec path patterns,description=List of glob patterns identifying local specs for components in this group,example=SPECS/**/.spec"`
+	SpecPathPatterns []string `toml:"specs,omitempty" json:"specs,omitempty" validate:"dive,required" jsonschema:"title=Spec path patterns,description=List of glob patterns identifying local specs for components in this group,example=SPECS/**/.spec"`
 	// List of glob patterns specifying files to specifically ignore from spec selection.
-	ExcludedPathPatterns []string `toml:"excluded-paths,omitempty" jsonschema:"title=Excluded path patterns,description=List of glob patterns identifying local paths to exclude from spec selection,example=build/**"`
+	ExcludedPathPatterns []string `toml:"excluded-paths,omitempty" json:"excludedPaths,omitempty" jsonschema:"title=Excluded path patterns,description=List of glob patterns identifying local paths to exclude from spec selection,example=build/**"`
 }
 
 // Returns a copy of the component group config with relative file paths converted to absolute
@@ -114,20 +114,20 @@ func (g ComponentGroupConfig) WithAbsolutePaths(referenceDir string) ComponentGr
 // Defines a component.
 type ComponentConfig struct {
 	// The component's name; not actually present in serialized files.
-	Name string `toml:"-" table:",sortkey"`
+	Name string `toml:"-" json:"-" table:",sortkey"`
 
 	// Reference to the source config file that this definition came from; not present
 	// in serialized files.
 	SourceConfigFile *ConfigFile `toml:"-" json:"-" table:"-"`
 
 	// Where to get its spec and adjacent files from.
-	Spec SpecSource `toml:"spec,omitempty" json:",omitempty" jsonschema:"title=Spec,description=Identifies where to find the spec for this component"`
+	Spec SpecSource `toml:"spec,omitempty" json:"spec,omitempty" jsonschema:"title=Spec,description=Identifies where to find the spec for this component"`
 
 	// Overlays to apply to sources after they've been acquired. May mutate the spec as well as sources.
-	Overlays []ComponentOverlay `toml:"overlays,omitempty" json:",omitempty" table:"-" jsonschema:"title=Overlays,description=Overlays to apply to this component's spec and/or sources"`
+	Overlays []ComponentOverlay `toml:"overlays,omitempty" json:"overlays,omitempty" table:"-" jsonschema:"title=Overlays,description=Overlays to apply to this component's spec and/or sources"`
 
 	// Configuration for building the component.
-	Build ComponentBuildConfig `toml:"build,omitempty" json:",omitempty" table:"-" jsonschema:"title=Build configuration,description=Configuration for building the component"`
+	Build ComponentBuildConfig `toml:"build,omitempty" json:"build,omitempty" table:"-" jsonschema:"title=Build configuration,description=Configuration for building the component"`
 }
 
 // Mutates the component config, updating it with overrides present in other.

internal/projectconfig/distro.go

@@ -12,9 +12,9 @@ import (
 // Encapsulates a reference to a version of a distro.
 type DistroReference struct {
 	// Name of the referenced distro.
-	Name string `toml:"name" jsonschema:"required,title=Name,description=Name of the referenced distro"`
+	Name string `toml:"name" json:"name,omitempty" jsonschema:"required,title=Name,description=Name of the referenced distro"`
 	// Version of the referenced distro.
-	Version string `toml:"version,omitempty" json:",omitempty" jsonschema:"title=Version,description=Version of the referenced distro"`
+	Version string `toml:"version,omitempty" json:"version,omitempty" jsonschema:"title=Version,description=Version of the referenced distro"`
 }
 
 // Implements the [Stringer] interface for [DistroReference].
@@ -35,47 +35,47 @@ func (r *DistroReference) String() string {
 // Defines a distro that components may be built for/against.
 type DistroDefinition struct {
 	// Human-readable description of the distro.
-	Description string `toml:"description,omitempty" jsonschema:"title=Description,description=Human readable description"`
+	Description string `toml:"description,omitempty" json:"description,omitempty" jsonschema:"title=Description,description=Human readable description"`
 
 	// Optionally provides a default version to use for this distro when one is not explicitly specified.
-	DefaultVersion string `toml:"default-version,omitempty" jsonschema:"title=Default version,description=Default version for this distro"`
+	DefaultVersion string `toml:"default-version,omitempty" json:"defaultVersion,omitempty" jsonschema:"title=Default version,description=Default version for this distro"`
 
 	// The base URI of this distro's dist-git spec source repository.
-	DistGitBaseURI string `toml:"dist-git-base-uri,omitempty" jsonschema:"format=uri,title=Dist-git base URI,description=Base URI for the dist-git repository for this distro"`
+	DistGitBaseURI string `toml:"dist-git-base-uri,omitempty" json:"distGitBaseUri,omitempty" jsonschema:"format=uri,title=Dist-git base URI,description=Base URI for the dist-git repository for this distro"`
 
 	// The base URI of this distro's lookaside cache for source archives.
-	LookasideBaseURI string `toml:"lookaside-base-uri,omitempty" jsonschema:"format=uri,title=Lookaside base URI,description=Base URI for lookaside cache for this distro"`
+	LookasideBaseURI string `toml:"lookaside-base-uri,omitempty" json:"lookasideBaseUri,omitempty" jsonschema:"format=uri,title=Lookaside base URI,description=Base URI for lookaside cache for this distro"`
 
 	// Published artifact information
-	PackageRepositories []PackageRepository `toml:"repos,omitempty" jsonschema:"title=Package Repositories,description=List of package repository definitions"`
+	PackageRepositories []PackageRepository `toml:"repos,omitempty" json:"repos,omitempty" jsonschema:"title=Package Repositories,description=List of package repository definitions"`
 
 	// Versions: maps version => definition
-	Versions map[string]DistroVersionDefinition `toml:"versions,omitempty" jsonschema:"title=Versions,description=Mapping of distro version definitions"`
+	Versions map[string]DistroVersionDefinition `toml:"versions,omitempty" json:"versions,omitempty" jsonschema:"title=Versions,description=Mapping of distro version definitions"`
 }
 
 // Defines how to access the published repository for a distro.
 type PackageRepository struct {
-	BaseURI string `toml:"base-uri" jsonschema:"required,title=Base URI,description=Base URI for the repository"`
+	BaseURI string `toml:"base-uri" json:"baseUri" jsonschema:"required,title=Base URI,description=Base URI for the repository"`
 }
 
 // Defines a specific version of a distro.
 type DistroVersionDefinition struct {
 	// Human-readable description of this version
-	Description string `toml:"description,omitempty" jsonschema:"title=Description,description=Human readable description of the distro version"`
+	Description string `toml:"description,omitempty" json:"description,omitempty" jsonschema:"title=Description,description=Human readable description of the distro version"`
 
 	// Formal `releasever` for this version.
-	ReleaseVer string `toml:"release-ver" jsonschema:"title=Release version,description=Formal releasever string"`
+	ReleaseVer string `toml:"release-ver" json:"releaseVer,omitempty" jsonschema:"title=Release version,description=Formal releasever string"`
 
 	// Dist-git branch for this version (if applicable)
-	DistGitBranch string `toml:"dist-git-branch,omitempty" jsonschema:"title=Dist-git branch,description=Branch in the dist-git repository for this version"`
+	DistGitBranch string `toml:"dist-git-branch,omitempty" json:"distGitBranch,omitempty" jsonschema:"title=Dist-git branch,description=Branch in the dist-git repository for this version"`
 
 	// Default config for components.
-	DefaultComponentConfig ComponentConfig `toml:"default-component-config,omitempty" jsonschema:"title=Default component config,description=Default component config inherited by all components built for this distro"`
+	DefaultComponentConfig ComponentConfig `toml:"default-component-config,omitempty" json:"defaultComponentConfig,omitempty" jsonschema:"title=Default component config,description=Default component config inherited by all components built for this distro"`
 
 	// Path to mock configuration file for this project (if one exists).
-	MockConfigPath        string `toml:"mock-config,omitempty"         validate:"omitempty,filepath" jsonschema:"title=Mock config file,description=Path to the mock config file for this version"`
-	MockConfigPathX86_64  string `toml:"mock-config-x86_64,omitempty"  validate:"omitempty,filepath" jsonschema:"title=Mock config file,description=Path to the x86_64 mock config file for this version"`
-	MockConfigPathAarch64 string `toml:"mock-config-aarch64,omitempty" validate:"omitempty,filepath" jsonschema:"title=Mock config file,description=Path to the aarch64 mock config file for this version"`
+	MockConfigPath        string `toml:"mock-config,omitempty"         json:"mockConfig,omitempty"        validate:"omitempty,filepath" jsonschema:"title=Mock config file,description=Path to the mock config file for this version"`
+	MockConfigPathX86_64  string `toml:"mock-config-x86_64,omitempty"  json:"mockConfigX8664,omitempty"   validate:"omitempty,filepath" jsonschema:"title=Mock config file,description=Path to the x86_64 mock config file for this version"`
+	MockConfigPathAarch64 string `toml:"mock-config-aarch64,omitempty" json:"mockConfigAarch64,omitempty" validate:"omitempty,filepath" jsonschema:"title=Mock config file,description=Path to the aarch64 mock config file for this version"`
 }
 
 // Returns a copy of the distro definition with relative file paths converted to absolute