test: update simulator

Signed-off-by: Marvin Drees <[email protected]>

Author: MDr164

internal/testutils/simulator/config.go

@@ -0,0 +1,34 @@
+// Copyright 2024 The Update Framework Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+package simulator
+
+import "github.com/theupdateframework/go-tuf/v2/metadata"
+
+type SimulatorOption interface {
+	apply(*RepositorySimulator)
+}
+
+type DelegatesOption map[string]metadata.Metadata[metadata.TargetsType]
+
+func (o DelegatesOption) apply(s *RepositorySimulator) {
+	s.MDDelegates = o
+}
+
+func WithDelegates(delegates map[string]metadata.Metadata[metadata.TargetsType]) SimulatorOption {
+	return DelegatesOption(delegates)
+}

internal/testutils/simulator/repository_simulator.go

@@ -51,15 +51,12 @@ package simulator
 
 import (
 	"bytes"
-	"crypto"
-	"crypto/ed25519"
 	"crypto/sha256"
 	"fmt"
 	"log/slog"
 	"net/url"
 	"os"
 	"path/filepath"
-	"regexp"
 	"strconv"
 	"strings"
 	"time"
@@ -161,7 +158,7 @@ func (rs *RepositorySimulator) setupMinimalValidRepository() {
 	rs.MDRoot = metadata.Root(rs.SafeExpiry)
 
 	for _, role := range metadata.TOP_LEVEL_ROLE_NAMES {
-		publicKey, _, signer := CreateKey()
+		publicKey, _, signer := createKey()
 
 		mtdkey, err := metadata.KeyFromPublicKey(*publicKey)
 		if err != nil {
@@ -212,20 +209,6 @@ func (rs *RepositorySimulator) AllTargets() <-chan metadata.TargetsType {
 	return ch
 }
 
-func CreateKey() (*ed25519.PublicKey, *ed25519.PrivateKey, *signature.Signer) {
-	public, private, err := ed25519.GenerateKey(nil)
-	if err != nil {
-		slog.Error("Failed to generate key", "err", err)
-	}
-
-	signer, err := signature.LoadSigner(private, crypto.Hash(0))
-	if err != nil {
-		slog.Error("failed to load signer", "err", err)
-	}
-
-	return &public, &private, &signer
-}
-
 func (rs *RepositorySimulator) AddSigner(role string, keyID string, signer signature.Signer) {
 	if _, ok := rs.Signers[role]; !ok {
 		rs.Signers[role] = make(map[string]*signature.Signer)
@@ -241,7 +224,7 @@ func (rs *RepositorySimulator) RotateKeys(role string) {
 	}
 
 	for i := 0; i < rs.MDRoot.Signed.Roles[role].Threshold; i++ {
-		publicKey, _, signer := CreateKey()
+		publicKey, _, signer := createKey()
 		mtdkey, err := metadata.KeyFromPublicKey(*publicKey)
 		if err != nil {
 			slog.Error("Repository simulator: key conversion failed while rotating keys", "err", err)
@@ -316,34 +299,6 @@ func (rs *RepositorySimulator) DownloadFile(urlPath string, maxLength int64, _ t
 	return data, err
 }
 
-func IsWindowsPath(path string) bool {
-	match, _ := regexp.MatchString(`^[a-zA-Z]:\\`, path)
-	return match
-}
-
-func trimPrefix(path string, prefix string) (string, error) {
-	var toTrim string
-	if IsWindowsPath(path) {
-		toTrim = path
-	} else {
-		parsedURL, e := url.Parse(path)
-		if e != nil {
-			return "", e
-		}
-		toTrim = parsedURL.Path
-	}
-
-	return strings.TrimPrefix(toTrim, prefix), nil
-}
-
-func hasPrefix(path, prefix string) bool {
-	return strings.HasPrefix(filepath.ToSlash(path), prefix)
-}
-
-func hasSuffix(path, prefix string) bool {
-	return strings.HasSuffix(filepath.ToSlash(path), prefix)
-}
-
 func (rs *RepositorySimulator) fetch(urlPath string) ([]byte, error) {
 	path, err := trimPrefix(urlPath, rs.LocalDir)
 	if err != nil {
@@ -552,7 +507,7 @@ func (rs *RepositorySimulator) AddDelegation(delegatorName string, role metadata
 	delegator.Delegations.Roles = append(delegator.Delegations.Roles, role)
 
 	// By default add one new key for the role
-	publicKey, _, signer := CreateKey()
+	publicKey, _, signer := createKey()
 	mdkey, err := metadata.KeyFromPublicKey(*publicKey)
 	if err != nil {
 		slog.Error("Repository simulator: key conversion failed while adding delegation", "err", err)
@@ -580,7 +535,7 @@ func (rs *RepositorySimulator) AddSuccinctRoles(delegatorName string, bitLength
 		slog.Error("Can't add a SuccinctRoles when delegated roles are used")
 		os.Exit(1)
 	}
-	publicKey, _, signer := CreateKey()
+	publicKey, _, signer := createKey()
 	mdkey, err := metadata.KeyFromPublicKey(*publicKey)
 	if err != nil {
 		slog.Error("Repository simulator: key conversion failed while adding succinct roles", "err", err)

internal/testutils/simulator/repository_simulator_setup.go

@@ -64,7 +64,7 @@ func InitLocalEnv() error {
 func InitMetadataDir() (*RepositorySimulator, string, string, error) {
 	if err := InitLocalEnv(); err != nil {
 		slog.Error("Failed to initialize environment", "err", err)
-		os.Exit(1)
+		return nil, "", "", err
 	}
 
 	metadataDir := filepath.Join(LocalDir, metadataPath)

internal/testutils/simulator/util.go

@@ -0,0 +1,76 @@
+// Copyright 2024 The Update Framework Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+package simulator
+
+import (
+	"crypto"
+	"crypto/ed25519"
+	"log/slog"
+	"net/url"
+	"path/filepath"
+	"regexp"
+	"strings"
+
+	"github.com/sigstore/sigstore/pkg/signature"
+)
+
+// createKey generates a new ed25519 public-private key pair and a signer using the private key.
+// It returns pointers to the public key, private key, and the signer.
+// If there is an error during the key generation or signer loading, it logs the error and continues.
+func createKey() (*ed25519.PublicKey, *ed25519.PrivateKey, *signature.Signer) {
+	public, private, err := ed25519.GenerateKey(nil)
+	if err != nil {
+		slog.Error("Failed to generate key", "err", err)
+	}
+
+	signer, err := signature.LoadSigner(private, crypto.Hash(0))
+	if err != nil {
+		slog.Error("Failed to load signer", "err", err)
+	}
+
+	return &public, &private, &signer
+}
+
+// trimPrefix is a function that takes a path and a prefix as input.
+// It checks if the path starts with a drive letter (e.g., "C:\").
+// If it does, it trims the prefix from the path.
+// If it doesn't, it parses the path as a URL and trims the prefix from the URL's path.
+// The function returns the trimmed path or an error if the path cannot be parsed as a URL.
+func trimPrefix(path string, prefix string) (string, error) {
+	var toTrim string
+	if match, _ := regexp.MatchString(`^[a-zA-Z]:\\`, path); match {
+		toTrim = path
+	} else {
+		parsedURL, err := url.Parse(path)
+		if err != nil {
+			return "", err
+		}
+
+		toTrim = parsedURL.Path
+	}
+
+	return strings.TrimPrefix(toTrim, prefix), nil
+}
+
+func hasPrefix(path, prefix string) bool {
+	return strings.HasPrefix(filepath.ToSlash(path), prefix)
+}
+
+func hasSuffix(path, prefix string) bool {
+	return strings.HasSuffix(filepath.ToSlash(path), prefix)
+}