Rename "repertory" module in "inventory" and refactor Sanitize function

Author: rsora

cli/cli.go

@@ -39,7 +39,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/upload"
 	"github.com/arduino/arduino-cli/cli/version"
 	"github.com/arduino/arduino-cli/configuration"
-	"github.com/arduino/arduino-cli/repertory"
+	"github.com/arduino/arduino-cli/inventory"
 	"github.com/mattn/go-colorable"
 	"github.com/rifflock/lfshook"
 	"github.com/sirupsen/logrus"
@@ -168,8 +168,8 @@ func preRun(cmd *cobra.Command, args []string) {
 	configuration.Init(configPath)
 	configFile := viper.ConfigFileUsed()
 
-	// initialize repertory
-	repertory.Init(viper.GetString("directories.Data"))
+	// initialize inventory
+	inventory.Init(viper.GetString("directories.Data"))
 
 	//
 	// Prepare logging

commands/compile/compile.go

@@ -47,7 +47,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 
 	tags := map[string]string{
 		"fqbn":            req.Fqbn,
-		"sketchPath":      telemetry.SanitizeSketchPath(req.SketchPath),
+		"sketchPath":      telemetry.Sanitize(req.SketchPath),
 		"showProperties":  strconv.FormatBool(req.ShowProperties),
 		"preprocess":      strconv.FormatBool(req.Preprocess),
 		"buildProperties": strings.Join(req.BuildProperties, ","),

repertory/repertory.go inventory/inventory.gorepertory/repertory.go renamed to inventory/inventory.go

@@ -13,7 +13,7 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package repertory
+package inventory
 
 import (
 	"os"
@@ -28,10 +28,10 @@ import (
 var Store = viper.New()
 
 var (
-	// Type is the repertory file type
+	// Type is the inventory file type
 	Type = "yaml"
-	// Name is the repertory file Name with Type as extension
-	Name = "repertory" + "." + Type
+	// Name is the inventory file Name with Type as extension
+	Name = "inventory" + "." + Type
 )
 
 // Init configures the Read Only config storage
@@ -48,7 +48,7 @@ func Init(configPath string) {
 			generateInstallationData()
 			writeStore(configFilePath)
 		} else {
-			feedback.Errorf("Error reading repertory file: %v", err)
+			feedback.Errorf("Error reading inventory file: %v", err)
 		}
 	}
 }
@@ -73,12 +73,12 @@ func writeStore(configFilePath string) {
 	// Create config dir if not present,
 	// MkdirAll will retrun no error if the path already exists
 	if err := os.MkdirAll(configPath, os.FileMode(0755)); err != nil {
-		feedback.Errorf("Error creating repertory dir: %v", err)
+		feedback.Errorf("Error creating inventory dir: %v", err)
 	}
 
 	// Create file if not present
 	err := Store.WriteConfigAs(configFilePath)
 	if err != nil {
-		feedback.Errorf("Error writing repertory file: %v", err)
+		feedback.Errorf("Error writing inventory file: %v", err)
 	}
 }

telemetry/telemetry.go

@@ -19,14 +19,12 @@ import (
 	"crypto/hmac"
 	"crypto/sha256"
 	"encoding/hex"
-	"net/http"
-	"path/filepath"
-
-	"github.com/arduino/arduino-cli/repertory"
+	"github.com/arduino/arduino-cli/inventory"
 	"github.com/segmentio/stats/v4"
 	"github.com/segmentio/stats/v4/prometheus"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/viper"
+	"net/http"
 )
 
 // serverPattern is the telemetry endpoint resource path for consume metrics
@@ -39,7 +37,7 @@ func Activate(metricPrefix string) {
 	// Create a new stats engine with an engine that prepends the "daemon" prefix to all metrics
 	// and includes the installationID as a tag, then replace the default stats engine
 	stats.DefaultEngine = stats.WithPrefix(metricPrefix, stats.T("installationID",
-		repertory.Store.GetString("installation.id")))
+		inventory.Store.GetString("installation.id")))
 	// Register the handler so it receives metrics from the default engine.
 	stats.Register(ph)
 
@@ -53,16 +51,15 @@ func Activate(metricPrefix string) {
 
 }
 
-// SanitizeSketchPath uses config generated UUID (installation.secret) as an HMAC secret to sanitize and anonymize
-// the sketch name maintaining it distinguishable from a different sketch from the same Installation
-func SanitizeSketchPath(sketchPath string) string {
-	logrus.Infof("repertory.Store.ConfigFileUsed() %s", repertory.Store.ConfigFileUsed())
-	installationSecret := repertory.Store.GetString("installation.secret")
-	sketchName := filepath.Base(sketchPath)
+// Sanitize uses config generated UUID (installation.secret) as an HMAC secret to sanitize and anonymize
+// a string, maintaining it distinguishable from a different string from the same Installation
+func Sanitize(s string) string {
+	logrus.Infof("inventory.Store.ConfigFileUsed() %s", inventory.Store.ConfigFileUsed())
+	installationSecret := inventory.Store.GetString("installation.secret")
 	// Create a new HMAC by defining the hash type and the key (as byte array)
 	h := hmac.New(sha256.New, []byte(installationSecret))
 	// Write Data to it
-	h.Write([]byte(sketchName))
+	h.Write([]byte(s))
 	// Get result and encode as hexadecimal string
 	return hex.EncodeToString(h.Sum(nil))
 }

test/test_daemon.py

@@ -26,20 +26,20 @@
 
 @pytest.mark.timeout(60)
 def test_telemetry_prometheus_endpoint(daemon_runner, data_dir):
-    # Wait for the repertory file to be created and then parse it
+    # Wait for the inventory file to be created and then parse it
     # in order to check the generated ids
-    repertory_file = os.path.join(data_dir, "repertory.yaml")
-    while not os.path.exists(repertory_file):
+    inventory_file = os.path.join(data_dir, "inventory.yaml")
+    while not os.path.exists(inventory_file):
         time.sleep(1)
-    with open(repertory_file, 'r') as stream:
-        repertory = yaml.safe_load(stream)
+    with open(inventory_file, 'r') as stream:
+        inventory = yaml.safe_load(stream)
 
         # Check if :9090/metrics endpoint is alive,
         # telemetry is enabled by default in daemon mode
         metrics = requests.get("http://localhost:9090/metrics").text
         family = next(text_string_to_metric_families(metrics))
         sample = family.samples[0]
-        assert repertory["installation"]["id"] == sample.labels["installationID"]
+        assert inventory["installation"]["id"] == sample.labels["installationID"]
 
     # Kill the runner's process as we finished our test (platform dependent)
     os_signal = signal.SIGTERM

test/test_main.py

@@ -75,7 +75,7 @@ def test_log_options(run_command, data_dir):
             json.loads(line)
 
 
-def test_repertory_creation(run_command, data_dir):
+def test_inventory_creation(run_command, data_dir):
     """
     using `version` as a test command
     """
@@ -84,8 +84,8 @@ def test_repertory_creation(run_command, data_dir):
     out_lines = run_command("version").stdout.strip().split("\n")
     assert len(out_lines) == 1
 
-    # parse repertory file
-    repertory_file = os.path.join(data_dir, "repertory.yaml")
-    with open(repertory_file, 'r') as stream:
-        repertory = yaml.safe_load(stream)
-        assert "installation" in repertory
+    # parse inventory file
+    inventory_file = os.path.join(data_dir, "inventory.yaml")
+    with open(inventory_file, 'r') as stream:
+        inventory = yaml.safe_load(stream)
+        assert "installation" in inventory