Add --attr to supply additional attributes to create-fw-bundle

CL: mos: Add --attr to supply additional attributes to create-fw-bundle

Author: rojer

common/fwbundle/fw_bundle.go

@@ -40,16 +40,21 @@ type FirmwareBundle struct {
 	tempDir string
 }
 
-type FirmwareManifest struct {
+type firmwareManifest struct {
 	Name           string                   `json:"name,omitempty"`
 	Platform       string                   `json:"platform,omitempty"`
 	Description    string                   `json:"description,omitempty"`
 	Version        string                   `json:"version,omitempty"`
 	BuildID        string                   `json:"build_id,omitempty"`
 	BuildTimestamp *time.Time               `json:"build_timestamp,omitempty"`
 	Parts          map[string]*FirmwarePart `json:"parts"`
+
+	// Extra attributes.
+	attrs map[string]interface{}
 }
 
+type FirmwareManifest firmwareManifest
+
 func NewBundle() *FirmwareBundle {
 	return &FirmwareBundle{}
 }
@@ -146,3 +151,49 @@ func (fw *FirmwareBundle) Cleanup() {
 		os.RemoveAll(fw.tempDir)
 	}
 }
+
+func (fwb *FirmwareBundle) SetAttr(attr string, value interface{}) {
+	if fwb.FirmwareManifest.attrs == nil {
+		fwb.FirmwareManifest.attrs = make(map[string]interface{})
+	}
+	fwb.FirmwareManifest.attrs[attr] = value
+}
+
+func (fwm FirmwareManifest) MarshalJSON() ([]byte, error) {
+	b, err := json.Marshal(firmwareManifest(fwm))
+	if err != nil {
+		return nil, err
+	}
+	if len(fwm.attrs) == 0 {
+		return b, nil
+	}
+	eb, err := json.Marshal(fwm.attrs)
+	if err != nil {
+		return nil, err
+	}
+	eb[0] = ','
+	rb := append(b[:len(b)-1], eb...)
+	return rb, nil
+}
+
+func (fwm FirmwareManifest) UnmarshalJSON(b []byte) error {
+	// Start by filling in the struct fields.
+	var fwm1 firmwareManifest
+	if err := json.Unmarshal(b, &fwm1); err != nil {
+		return err
+	}
+	*(&fwm) = FirmwareManifest(fwm1)
+	// Re-parse as a generic map.
+	var mp map[string]interface{}
+	json.Unmarshal(b, &mp)
+	// Find keys that are not fields in the struct and add them as attrs.
+	for k, v := range mp {
+		if !isJSONField(fwm, k) {
+			if fwm.attrs == nil {
+				fwm.attrs = make(map[string]interface{})
+			}
+			fwm.attrs[k] = v
+		}
+	}
+	return nil
+}

common/fwbundle/fw_part.go

@@ -56,8 +56,9 @@ type firmwarePart struct {
 	// Deprecated, not being used since 2018/12/03.
 	CC3200FileSignature string `json:"sign,omitempty"`
 
-	// Other user-specified properties are preserved here.
-	properties   map[string]interface{}
+	// Other user-specified attributes are preserved here.
+	attrs map[string]interface{}
+
 	data         []byte
 	dataProvider DataProvider
 }
@@ -69,7 +70,7 @@ func PartFromString(ps string) (*FirmwarePart, error) {
 	if len(np) < 2 {
 		return nil, errors.Errorf("invalid part spec '%s', must be 'name:prop=value,...'", ps)
 	}
-	// Create properties JSON and re-parse it.
+	// Create attrs JSON and re-parse it.
 	m := make(map[string]interface{})
 	for _, prop := range strings.Split(np[1], ",") {
 		if len(prop) == 0 {
@@ -184,10 +185,10 @@ func (p *FirmwarePart) MarshalJSON() ([]byte, error) {
 	if err != nil {
 		return nil, err
 	}
-	if len(p.properties) == 0 {
+	if len(p.attrs) == 0 {
 		return b, nil
 	}
-	eb, err := json.Marshal(p.properties)
+	eb, err := json.Marshal(p.attrs)
 	if err != nil {
 		return nil, err
 	}
@@ -218,13 +219,13 @@ func (p *FirmwarePart) UnmarshalJSON(b []byte) error {
 	// Re-parse as a generic map.
 	var mp map[string]interface{}
 	json.Unmarshal(b, &mp)
-	// Find keys that are not fields in the struct and add them as properties.
+	// Find keys that are not fields in the struct and add them as attrs.
 	for k, v := range mp {
 		if !isJSONField(p, k) {
-			if p.properties == nil {
-				p.properties = make(map[string]interface{})
+			if p.attrs == nil {
+				p.attrs = make(map[string]interface{})
 			}
-			p.properties[k] = v
+			p.attrs[k] = v
 		}
 	}
 	return nil

mos/common/common.go

@@ -5,6 +5,8 @@ package moscommon
 
 import (
 	"strings"
+
+	"github.com/cesanta/errors"
 )
 
 const (
@@ -29,3 +31,17 @@ func ExpandPlaceholders(s, ps, ss string) string {
 	}
 	return res
 }
+
+func ParseParamValues(args []string) (map[string]string, error) {
+	ret := map[string]string{}
+	for _, a := range args {
+		// Split arg into two substring by "=" (so, param name name cannot contain
+		// "=", but value can)
+		subs := strings.SplitN(a, "=", 2)
+		if len(subs) < 2 {
+			return nil, errors.Errorf("missing value for %q", a)
+		}
+		ret[subs[0]] = subs[1]
+	}
+	return ret, nil
+}

mos/config/config.go

@@ -20,14 +20,14 @@ import (
 	"context"
 	"fmt"
 	"sort"
-	"strings"
 	"time"
 
-	"github.com/mongoose-os/mos/mos/ourutil"
-	"github.com/mongoose-os/mos/mos/dev"
-	"github.com/mongoose-os/mos/mos/flags"
 	"github.com/cesanta/errors"
 	"github.com/golang/glog"
+	moscommon "github.com/mongoose-os/mos/mos/common"
+	"github.com/mongoose-os/mos/mos/dev"
+	"github.com/mongoose-os/mos/mos/flags"
+	"github.com/mongoose-os/mos/mos/ourutil"
 	flag "github.com/spf13/pflag"
 )
 
@@ -86,7 +86,7 @@ func SetWithArgs(
 		return errors.Trace(err)
 	}
 
-	paramValues, err := parseParamValues(args)
+	paramValues, err := moscommon.ParseParamValues(args)
 	if err != nil {
 		return errors.Trace(err)
 	}
@@ -168,20 +168,6 @@ func SetAndSave(ctx context.Context, devConn dev.DevConn, devConf *dev.DevConf)
 	return SetAndSaveLevel(ctx, devConn, devConf, *flags.Level)
 }
 
-func parseParamValues(args []string) (map[string]string, error) {
-	ret := map[string]string{}
-	for _, a := range args {
-		// Split arg into two substring by "=" (so, param name name cannot contain
-		// "=", but value can)
-		subs := strings.SplitN(a, "=", 2)
-		if len(subs) < 2 {
-			return nil, errors.Errorf("missing value for %q", a)
-		}
-		ret[subs[0]] = subs[1]
-	}
-	return ret, nil
-}
-
 func ApplyDiff(devConf *dev.DevConf, newConf map[string]string) error {
 	ourutil.Reportf("\nUpdating config:")
 	keys := []string{}

mos/create_fw_bundle/create_fw_bundle.go

@@ -22,15 +22,17 @@ import (
 	"fmt"
 	"io/ioutil"
 	"path/filepath"
+	"strconv"
 	"strings"
 
+	moscommon "github.com/mongoose-os/mos/mos/common"
 	"github.com/mongoose-os/mos/mos/dev"
 	"github.com/mongoose-os/mos/mos/flags"
 	"github.com/mongoose-os/mos/mos/version"
 
+	"github.com/cesanta/errors"
 	"github.com/mongoose-os/mos/common/fwbundle"
 	"github.com/mongoose-os/mos/mos/ourutil"
-	"github.com/cesanta/errors"
 	flag "github.com/spf13/pflag"
 )
 
@@ -112,6 +114,26 @@ func CreateFWBundle(ctx context.Context, devConn dev.DevConn) error {
 			}
 		}
 	}
+	attrs, err := moscommon.ParseParamValues(*flags.Attr)
+	if err != nil {
+		return errors.Annotatef(err, "failed to parse --attr")
+	}
+	for attr, valueStr := range attrs {
+		var value interface{}
+		switch valueStr {
+		case "true":
+			value = true
+		case "false":
+			value = false
+		default:
+			if i, err := strconv.ParseInt(valueStr, 0, 64); err == nil {
+				value = i
+			} else {
+				value = valueStr
+			}
+		}
+		fwb.SetAttr(attr, value)
+	}
 	ourutil.Reportf("Writing %s", *flags.Output)
 	return fwbundle.WriteZipFirmwareBundle(fwb, *flags.Output, *flags.Compress)
 }

mos/flags/flags.go

@@ -89,6 +89,8 @@ var (
 
 	KeepTempFiles = flag.Bool("keep-temp-files", false, "keep temp files after the build is done (by default they are in ~/.mos/tmp)")
 	KeepFS        = flag.Bool("keep-fs", false, "When flashing, skip the filesystem parts")
+
+	Attr = flag.StringArray("attr", []string{}, "manifest attribute, can be used multiple times")
 )
 
 func Platform() string {