Pass device metadate as values instead of reading current config (#22)

iljarotar · web-flow · commit b88d39ed5352 · 2025-05-28T08:57:45.000+02:00
diff --git a/README.md b/README.md
@@ -65,6 +65,31 @@ Result:
 
 For each breakout also the correspondig ports entries are added.
 
+### device_metadata
+
+Example:
+
+```yaml
+device_metadata:
+  hwsku: Accton-AS7726-32X
+  mac: aa:aa:aa:aa:aa:aa
+  platform: x86_64-accton_as7726_32x-r0
+```
+
+Result:
+
+```json
+{
+  "DEVICE_METADATA": {
+    "localhost": {
+      "hwsku": "Accton-AS7726-32X",
+      "mac": "aa:aa:aa:aa:aa:aa",
+      "platform": "x86_64-accton_as7726_32x-r0"
+    }
+  }
+}
+```
+
 ### docker_routing_config_mode
 
 Can be one of `separated`, `split`, `split-unified`, `unified`.
diff --git a/cmd/generate.go b/cmd/generate.go
@@ -15,21 +15,23 @@ var generateCmd = &cobra.Command{
 	Use:   "generate",
 	Short: "Generate a config_db.json",
 	Run: func(cmd *cobra.Command, args []string) {
-		configDBFile, _ := cmd.Flags().GetString("config-db")
-		configDBBytes, err := os.ReadFile(configDBFile)
+		inputFile, _ := cmd.Flags().GetString("input-file")
+		outputFile, _ := cmd.Flags().GetString("output-file")
+		deviceDir, _ := cmd.Flags().GetString("device-dir")
+
+		inputBytes, err := os.ReadFile(inputFile)
 		if err != nil {
-			fmt.Printf("failed to read current config file, %v\n", err)
+			fmt.Printf("failed to read input file, %v\n", err)
 			os.Exit(1)
 		}
 
-		currentConfig, err := configdb.UnmarshalConfigDB(configDBBytes)
+		values, err := values.UnmarshalValues(inputBytes)
 		if err != nil {
-			fmt.Printf("failed to parse current config file, %v\n", err)
+			fmt.Printf("failed to parse input file, %v\n", err)
 			os.Exit(1)
 		}
 
-		platformIdentifier := currentConfig.DeviceMetadata.Localhost.Platform
-		deviceDir, _ := cmd.Flags().GetString("device-dir")
+		platformIdentifier := values.DeviceMetadata.Platform
 		platformFile := fmt.Sprintf("%s/%s/platform.json", deviceDir, platformIdentifier)
 
 		platformBytes, err := os.ReadFile(platformFile)
@@ -44,32 +46,18 @@ var generateCmd = &cobra.Command{
 			os.Exit(1)
 		}
 
-		inputFile, _ := cmd.Flags().GetString("input-file")
-		inputBytes, err := os.ReadFile(inputFile)
-		if err != nil {
-			fmt.Printf("failed to read input file, %v\n", err)
-			os.Exit(1)
-		}
-
-		values, err := values.UnmarshalValues(inputBytes)
-		if err != nil {
-			fmt.Printf("failed to parse input file, %v\n", err)
-			os.Exit(1)
-		}
-
-		configDB, err := configdb.GenerateConfigDB(values, platform, currentConfig.DeviceMetadata)
+		configDB, err := configdb.GenerateConfigDB(values, platform, values.DeviceMetadata)
 		if err != nil {
 			fmt.Printf("failed to generate config, %v\n", err)
 			os.Exit(1)
 		}
 
-		configDBBytes, err = json.MarshalIndent(configDB, "", "  ")
+		configDBBytes, err := json.MarshalIndent(configDB, "", "  ")
 		if err != nil {
 			fmt.Printf("failed to serialize json, %v\n", err)
 			os.Exit(1)
 		}
 
-		outputFile, _ := cmd.Flags().GetString("output-file")
 		err = os.WriteFile(outputFile, configDBBytes, 0644) //nolint:gosec
 		if err != nil {
 			fmt.Printf("failed to write file, %v", err)
@@ -84,5 +72,4 @@ func init() {
 	generateCmd.Flags().StringP("input-file", "i", "sonic-config.yaml", "path to input file to generate the config_db.json from")
 	generateCmd.Flags().StringP("output-file", "o", "config_db.json", "path to output file")
 	generateCmd.Flags().String("device-dir", "/usr/share/sonic/device", "directory which holds all device-specific files")
-	generateCmd.Flags().StringP("config-db", "c", "/etc/sonic/config_db.json", "path to current config_db.json")
 }
diff --git a/configdb/configdb.go b/configdb/configdb.go
@@ -43,7 +43,7 @@ type ConfigDB struct {
 	VXLANTunnelMap     VXLANTunnelMap              `json:"VXLAN_TUNNEL_MAP,omitempty"`
 }
 
-func GenerateConfigDB(input *values.Values, platform *p.Platform, currentDeviceMetadata DeviceMetadata) (*ConfigDB, error) {
+func GenerateConfigDB(input *values.Values, platform *p.Platform, currentDeviceMetadata values.DeviceMetadata) (*ConfigDB, error) {
 	if input == nil {
 		return nil, fmt.Errorf("no input values provided")
 	}
@@ -168,16 +168,16 @@ func getACLRulesAndTables(sourceRanges []string) (map[string]ACLRule, map[string
 	return rules, tables
 }
 
-func getDeviceMetadata(input *values.Values, currentMetadata DeviceMetadata) (*DeviceMetadata, error) {
-	if currentMetadata.Localhost.Platform == "" {
+func getDeviceMetadata(input *values.Values, currentMetadata values.DeviceMetadata) (*DeviceMetadata, error) {
+	if currentMetadata.Platform == "" {
 		return nil, fmt.Errorf("missing platform from current device metadata")
 	}
 
-	if currentMetadata.Localhost.HWSKU == "" {
+	if currentMetadata.HWSKU == "" {
 		return nil, fmt.Errorf("missing hwsku from current device metadata")
 	}
 
-	if currentMetadata.Localhost.MAC == "" {
+	if currentMetadata.MAC == "" {
 		return nil, fmt.Errorf("missing mac from current device metadata")
 	}
 
@@ -186,9 +186,9 @@ func getDeviceMetadata(input *values.Values, currentMetadata DeviceMetadata) (*D
 			DockerRoutingConfigMode: DockerRoutingConfigMode(input.DockerRoutingConfigMode),
 			FRRMgmtFrameworkConfig:  strconv.FormatBool(input.FRRMgmtFrameworkConfig),
 			Hostname:                input.Hostname,
-			HWSKU:                   currentMetadata.Localhost.HWSKU,
-			MAC:                     currentMetadata.Localhost.MAC,
-			Platform:                currentMetadata.Localhost.Platform,
+			HWSKU:                   currentMetadata.HWSKU,
+			MAC:                     currentMetadata.MAC,
+			Platform:                currentMetadata.Platform,
 			RouterType:              "LeafRouter",
 		},
 	}, nil
diff --git a/tests/1/current-config_db.json b/tests/1/current-config_db.json
diff --git a/tests/1/sonic-config.yaml b/tests/1/sonic-config.yaml
@@ -5,6 +5,11 @@ bgp_ports:
 breakouts:
   Ethernet0: 4x25G
 
+device_metadata:
+  hwsku: Accton-AS7726-32X
+  mac: aa:aa:aa:aa:aa:aa
+  platform: x86_64-accton_as7726_32x-r0
+
 docker_routing_config_mode: split
 
 features:
diff --git a/tests/2/current-config_db.json b/tests/2/current-config_db.json
diff --git a/tests/2/sonic-config.yaml b/tests/2/sonic-config.yaml
@@ -5,6 +5,11 @@ bgp_ports:
 breakouts:
   Ethernet0: 4x25G
 
+device_metadata:
+  hwsku: Accton-AS7726-32X
+  mac: aa:aa:aa:aa:aa:aa
+  platform: x86_64-accton_as7726_32x-r0
+
 docker_routing_config_mode: split
 features: {}
 frr_mgmt_framework_config: false
diff --git a/tests/3/current-config_db.json b/tests/3/current-config_db.json
diff --git a/tests/3/sonic-config.yaml b/tests/3/sonic-config.yaml
@@ -2,6 +2,11 @@ bgp_ports:
   - Ethernet0
   - Ethernet1
 
+device_metadata:
+  hwsku: Accton-AS4630-54TE
+  mac: aa:aa:aa:aa:aa:aa
+  platform: x86_64-accton_as4630_54te-r0
+
 docker_routing_config_mode: split
 frr_mgmt_framework_config: true
 hostname: mgmtspine
diff --git a/tests/4/current-config_db.json b/tests/4/current-config_db.json
diff --git a/tests/4/sonic-config.yaml b/tests/4/sonic-config.yaml
@@ -1,3 +1,8 @@
+device_metadata:
+  hwsku: Accton-AS4625-54T
+  mac: aa:aa:aa:aa:aa:aa
+  platform: x86_64-accton_as4625_54t-r0
+
 docker_routing_config_mode: split
 frr_mgmt_framework_config: false
 hostname: leaf01
diff --git a/tests/test.sh b/tests/test.sh
@@ -3,7 +3,7 @@
 for i in 1 2 3 4
 do
   test_dir=$(pwd)/tests/$i
-  docker run --rm -v $(pwd)/tests/device:/usr/share/sonic/device:ro -v $test_dir:/sonic sonic-configdb-utils:local generate -c /sonic/current-config_db.json -i /sonic/sonic-config.yaml -o /sonic/config_db.json
+  docker run --rm -v $(pwd)/tests/device:/usr/share/sonic/device:ro -v $test_dir:/sonic sonic-configdb-utils:local generate -i /sonic/sonic-config.yaml -o /sonic/config_db.json
   diff --color=always $test_dir/expected.json $test_dir/config_db.json
 
   if [[ $? != 0 ]]; then
diff --git a/values/values.go b/values/values.go
@@ -9,6 +9,12 @@ const (
 	AutonegModeOff AutonegMode = "off"
 )
 
+type DeviceMetadata struct {
+	HWSKU    string `yaml:"hwsku"`
+	MAC      string `yaml:"mac"`
+	Platform string `yaml:"platform"`
+}
+
 type DockerRoutingConfigMode string
 
 const (
@@ -92,6 +98,7 @@ type SAG struct {
 type Values struct {
 	BGPPorts                []string                `yaml:"bgp_ports"`
 	Breakouts               map[string]string       `yaml:"breakouts"`
+	DeviceMetadata          DeviceMetadata          `yaml:"device_metadata"`
 	DockerRoutingConfigMode DockerRoutingConfigMode `yaml:"docker_routing_config_mode"`
 	Features                map[string]Feature      `yaml:"features"`
 	FRRMgmtFrameworkConfig  bool                    `yaml:"frr_mgmt_framework_config"`
