Different way to retrieve platform information (#12)

Author: iljarotar

Makefile

@@ -35,7 +35,7 @@ test-generate: docker-build
 
 .PHONY: lint
 lint:
-	golangci-lint run --build-tags client -p bugs -p unused
+	golangci-lint run -p bugs -p unused
 
 .PHONY: docker-build
 docker-build:

README.md

@@ -11,6 +11,19 @@ Then run
 sonic-confidb-utils generate
 ```
 
+Following files and directories are expected to be in place:
+
+1. The `/usr/share/sonic/device` directory holds all device specific information. `sonic-configdb-utils` needs to read `usr/share/sonic/device/<platform-identifier>/platform.json` to set and validate the ports' breakout configurations.
+2. To retrieve the platform identifier and HWSKU the `/etc/sonic/sonic-environment` file is read which looks like this:
+
+```bash
+SONIC_VERSION=sonic-123
+PLATFORM=x86_64-accton_as7726_32x-r0
+HWSKU=Accton-AS7726-32X
+DEVICE_TYPE=LeafRouter
+ASIC_TYPE=broadcom
+```
+
 ## Configuration Parameters
 
 ### bgp_ports
@@ -65,31 +78,6 @@ 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`.
@@ -630,16 +618,17 @@ Result:
 }
 ```
 
-### vteps
+### vtep
 
 Example:
 
 ```yaml
 loopback_address: 10.7.7.7
 
-vteps:
-  - vni: 103999
-    vlan: Vlan3999
+vtep:
+  vxlan_tunnel_maps:
+    - vni: 103999
+      vlan: Vlan3999
 ```
 
 Result:
@@ -664,3 +653,29 @@ Result:
   }
 }
 ```
+
+If only `VXLAN_EVPN_NVO` and `VXLAN_TUNNEL` are needed with no tunnel maps:
+
+```yaml
+loopback_address: 10.7.7.7
+
+vtep:
+  enabled: true
+```
+
+Result:
+
+```json
+{
+  "VXLAN_EVPN_NVO": {
+    "nvo": {
+      "source_vtep": "vtep"
+    }
+  },
+  "VXLAN_TUNNEL": {
+    "vtep": {
+      "src_ip": "10.7.7.7"
+    }
+  }
+}
+```

cmd/generate.go

@@ -14,7 +14,14 @@ import (
 var generateCmd = &cobra.Command{
 	Use:   "generate",
 	Short: "Generate a config_db.json",
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
+		sonicEnvFile, _ := cmd.Flags().GetString("env-file")
+		env, err := p.GetEnvironment(sonicEnvFile)
+		if err != nil {
+			return fmt.Errorf("failed to get environment information:%w", err)
+		}
+
+		platformIdentifier := env.Platform
 		inputFile, _ := cmd.Flags().GetString("input-file")
 		outputFile, _ := cmd.Flags().GetString("output-file")
 		deviceDir, _ := cmd.Flags().GetString("device-dir")
@@ -31,38 +38,34 @@ var generateCmd = &cobra.Command{
 			os.Exit(1)
 		}
 
-		platformIdentifier := values.DeviceMetadata.Platform
 		platformFile := fmt.Sprintf("%s/%s/platform.json", deviceDir, platformIdentifier)
 
 		platformBytes, err := os.ReadFile(platformFile)
 		if err != nil {
-			fmt.Printf("failed to read platform.json file: %v\n", err)
-			os.Exit(1)
+			return fmt.Errorf("failed to read platform.json file:%w", err)
 		}
 
 		platform, err := p.UnmarshalPlatformJSON(platformBytes)
 		if err != nil {
-			fmt.Printf("failed to parse platform.json: %v\n", err)
-			os.Exit(1)
+			return fmt.Errorf("failed to parse platform.json:%w", err)
 		}
 
-		configDB, err := configdb.GenerateConfigDB(values, platform, values.DeviceMetadata)
+		configDB, err := configdb.GenerateConfigDB(values, platform, env)
 		if err != nil {
-			fmt.Printf("failed to generate config, %v\n", err)
-			os.Exit(1)
+			return fmt.Errorf("failed to generate config:%w", err)
 		}
 
 		configDBBytes, err := json.MarshalIndent(configDB, "", "  ")
 		if err != nil {
-			fmt.Printf("failed to serialize json, %v\n", err)
-			os.Exit(1)
+			return fmt.Errorf("failed to serialize json:%w", err)
 		}
 
 		err = os.WriteFile(outputFile, configDBBytes, 0644) //nolint:gosec
 		if err != nil {
-			fmt.Printf("failed to write file, %v", err)
-			os.Exit(1)
+			return fmt.Errorf("failed to write file:%w", err)
 		}
+
+		return nil
 	},
 }
 
@@ -72,4 +75,5 @@ 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("env-file", "e", "/etc/sonic/sonic-environment", "sonic-environment file holding platform information")
 }

configdb/configdb.go

@@ -7,6 +7,7 @@ import (
 	"slices"
 	"strconv"
 
+	"github.com/metal-stack/sonic-configdb-utils/platform"
 	p "github.com/metal-stack/sonic-configdb-utils/platform"
 	"github.com/metal-stack/sonic-configdb-utils/values"
 )
@@ -43,7 +44,7 @@ type ConfigDB struct {
 	VXLANTunnelMap     VXLANTunnelMap              `json:"VXLAN_TUNNEL_MAP,omitempty"`
 }
 
-func GenerateConfigDB(input *values.Values, platform *p.Platform, currentDeviceMetadata values.DeviceMetadata) (*ConfigDB, error) {
+func GenerateConfigDB(input *values.Values, platform *p.Platform, environment *platform.Environment) (*ConfigDB, error) {
 	if input == nil {
 		return nil, fmt.Errorf("no input values provided")
 	}
@@ -56,7 +57,7 @@ func GenerateConfigDB(input *values.Values, platform *p.Platform, currentDeviceM
 		return nil, err
 	}
 
-	deviceMetadata, err := getDeviceMetadata(input, currentDeviceMetadata)
+	deviceMetadata, err := getDeviceMetadata(input, environment)
 	if err != nil {
 		return nil, err
 	}
@@ -168,27 +169,27 @@ func getACLRulesAndTables(sourceRanges []string) (map[string]ACLRule, map[string
 	return rules, tables
 }
 
-func getDeviceMetadata(input *values.Values, currentMetadata values.DeviceMetadata) (*DeviceMetadata, error) {
-	if currentMetadata.Platform == "" {
-		return nil, fmt.Errorf("missing platform from current device metadata")
+func getDeviceMetadata(input *values.Values, environment *platform.Environment) (*DeviceMetadata, error) {
+	if environment.Platform == "" {
+		return nil, fmt.Errorf("no platform identifiert found in environment file")
 	}
 
-	if currentMetadata.HWSKU == "" {
-		return nil, fmt.Errorf("missing hwsku from current device metadata")
+	if environment.HWSKU == "" {
+		return nil, fmt.Errorf("no hwsku found in environment file")
 	}
 
-	if currentMetadata.MAC == "" {
-		return nil, fmt.Errorf("missing mac from current device metadata")
+	if environment.MAC == "" {
+		return nil, fmt.Errorf("failed to retrieve system mac address")
 	}
 
 	return &DeviceMetadata{
 		Localhost: Metadata{
 			DockerRoutingConfigMode: DockerRoutingConfigMode(input.DockerRoutingConfigMode),
 			FRRMgmtFrameworkConfig:  strconv.FormatBool(input.FRRMgmtFrameworkConfig),
 			Hostname:                input.Hostname,
-			HWSKU:                   currentMetadata.HWSKU,
-			MAC:                     currentMetadata.MAC,
-			Platform:                currentMetadata.Platform,
+			HWSKU:                   environment.HWSKU,
+			MAC:                     environment.MAC,
+			Platform:                environment.Platform,
 			RouterType:              "LeafRouter",
 		},
 	}, nil

platform/environment.go

@@ -0,0 +1,56 @@
+package platform
+
+import (
+	"bufio"
+	"fmt"
+	"os"
+	"strings"
+)
+
+type Environment struct {
+	HWSKU    string
+	MAC      string
+	Platform string
+}
+
+func GetEnvironment(envFile string) (*Environment, error) {
+	var (
+		hwsku    string
+		mac      string
+		platform string
+	)
+
+	file, err := os.Open(envFile)
+	if err != nil {
+		return nil, err
+	}
+	defer func() {
+		err := file.Close()
+		if err != nil {
+			fmt.Printf("failed to close file:%v", err)
+		}
+	}()
+
+	scanner := bufio.NewScanner(file)
+	for scanner.Scan() {
+		line := scanner.Text()
+		if p, ok := strings.CutPrefix(line, "PLATFORM="); ok {
+			platform = p
+		}
+		if h, ok := strings.CutPrefix(line, "HWSKU="); ok {
+			hwsku = h
+		}
+	}
+
+	addrBytes, err := os.ReadFile("/sys/class/net/eth0/address")
+	if err != nil {
+		return nil, fmt.Errorf("failed to get mac address:%w", err)
+	}
+	mac = strings.TrimSpace(string(addrBytes))
+
+	return &Environment{
+		HWSKU:    hwsku,
+		MAC:      mac,
+		Platform: platform,
+	}, nil
+}

tests/1/sonic-config.yaml

@@ -5,11 +5,6 @@ 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:

tests/1/sonic-environment

@@ -0,0 +1,2 @@
+PLATFORM=x86_64-accton_as7726_32x-r0
+HWSKU=Accton-AS7726-32X

tests/2/sonic-config.yaml

@@ -6,11 +6,6 @@ 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

tests/2/sonic-environment

@@ -0,0 +1,2 @@
+PLATFORM=x86_64-accton_as7726_32x-r0
+HWSKU=Accton-AS7726-32X

tests/3/sonic-config.yaml

@@ -2,11 +2,6 @@ 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