Merge branch 'master' into context

Author: mmetc

azure-pipelines.yml

@@ -21,7 +21,7 @@ stages:
           - task: GoTool@0
             displayName: "Install Go"
             inputs:
-                version: '1.23.3'
+                version: '1.24.0'
 
           - pwsh: |
               choco install -y make

pkg/cwhub/item.go

@@ -113,10 +113,13 @@ type Item struct {
 	Dependencies
 }
 
-// InstallPath returns the location of the symlink to the item in the hub, or the path of the item itself if it's local
-// (eg. /etc/crowdsec/collections/xyz.yaml).
-// Raises an error if the path goes outside of the install dir.
+// InstallPath returns the path to use for the install symlink.
+// Returns an error if an item is already installed or if the path goes outside of the install dir.
 func (i *Item) InstallPath() (string, error) {
+	if i.State.Installed {
+		return "", fmt.Errorf("%s is already installed at %s", i.FQName(), i.State.LocalPath)
+	}
+
 	p := i.Type
 	if i.Stage != "" {
 		p = filepath.Join(p, i.Stage)
@@ -205,13 +208,7 @@ func (i *Item) CurrentDependencies() Dependencies {
 		return i.Dependencies
 	}
 
-	contentPath, err := i.InstallPath()
-	if err != nil {
-		i.hub.logger.Warningf("can't access dependencies for %s, using index", i.FQName())
-		return i.Dependencies
-	}
-
-	currentContent, err := os.ReadFile(contentPath)
+	currentContent, err := os.ReadFile(i.State.LocalPath)
 	if errors.Is(err, fs.ErrNotExist) {
 		return i.Dependencies
 	}

pkg/cwhub/sync.go

@@ -10,7 +10,6 @@ import (
 	"strings"
 
 	"github.com/Masterminds/semver/v3"
-	"github.com/sirupsen/logrus"
 	"gopkg.in/yaml.v3"
 
 	"github.com/crowdsecurity/go-cs-lib/downloader"
@@ -86,7 +85,7 @@ type itemSpec struct {
 	local   bool   // is this a spec for a local item?
 }
 
-func newHubItemSpec(path string, subs []string, logger *logrus.Logger) (*itemSpec, error) {
+func newHubItemSpec(path string, subs []string) (*itemSpec, error) {
 	// .../hub/parsers/s00-raw/crowdsecurity/skip-pretag.yaml
 	// .../hub/scenarios/crowdsecurity/ssh_bf.yaml
 	// .../hub/profiles/crowdsecurity/linux.yaml
@@ -126,9 +125,7 @@ func newHubItemSpec(path string, subs []string, logger *logrus.Logger) (*itemSpe
 	return &spec, nil
 }
 
-func newInstallItemSpec(path string, subs []string, logger *logrus.Logger) (*itemSpec, error) {
-	logger.Tracef("%s in install dir", path)
-
+func newInstallItemSpec(path string, subs []string) (*itemSpec, error) {
 	// .../config/parser/stage/file.yaml
 	// .../config/postoverflow/stage/file.yaml
 	// .../config/scenarios/scenar.yaml
@@ -161,19 +158,19 @@ func newInstallItemSpec(path string, subs []string, logger *logrus.Logger) (*ite
 	return &spec, nil
 }
 
-func newItemSpec(path, hubDir, installDir string, logger *logrus.Logger) (*itemSpec, error) {
+func newItemSpec(path, hubDir, installDir string) (*itemSpec, error) {
 	var (
 		spec *itemSpec
 		err  error
 	)
 
 	if subs := relativePathComponents(path, hubDir); len(subs) > 0 {
-		spec, err = newHubItemSpec(path, subs, logger)
+		spec, err = newHubItemSpec(path, subs)
 		if err != nil {
 			return nil, err
 		}
 	} else if subs := relativePathComponents(path, installDir); len(subs) > 0 {
-		spec, err = newInstallItemSpec(path, subs, logger)
+		spec, err = newInstallItemSpec(path, subs)
 		if err != nil {
 			return nil, err
 		}
@@ -306,7 +303,7 @@ func (h *Hub) itemVisit(path string, f os.DirEntry, err error) (*itemSpec, error
 		return nil, ErrSkipPath
 	}
 
-	spec, err := newItemSpec(path, h.local.HubDir, h.local.InstallDir, h.logger)
+	spec, err := newItemSpec(path, h.local.HubDir, h.local.InstallDir)
 	if err != nil {
 		h.logger.Warningf("Ignoring file %s: %s", path, err)
 		return nil, ErrSkipPath
@@ -323,10 +320,6 @@ func updateNonLocalItem(h *Hub, path string, spec *itemSpec, symlinkTarget strin
 	}
 
 	for _, item := range h.GetItemMap(spec.ftype) {
-		if spec.fname != item.FileName {
-			continue
-		}
-
 		if item.Stage != spec.stage {
 			continue
 		}
@@ -405,6 +398,8 @@ func (h *Hub) addItemFromSpec(spec *itemSpec) error {
 		if err != nil {
 			return err
 		}
+
+		item.State.LocalPath = spec.path
 	}
 
 	if item == nil {
@@ -653,7 +648,6 @@ func (i *Item) setVersionState(path string, inhub bool) error {
 		i.hub.logger.Tracef("got tainted match for %s: %s", i.Name, path)
 
 		if !inhub {
-			i.State.LocalPath = path
 			i.State.Installed = true
 		}
 
@@ -669,7 +663,6 @@ func (i *Item) setVersionState(path string, inhub bool) error {
 
 	if !inhub {
 		i.hub.logger.Tracef("found exact match for %s, version is %s, latest is %s", i.Name, i.State.LocalVersion, i.Version)
-		i.State.LocalPath = path
 		i.State.Tainted = false
 		// if we're walking the hub, present file doesn't means installed file
 		i.State.Installed = true

pkg/hubops/datarefresh.go

@@ -11,21 +11,16 @@ import (
 // XXX: TODO: temporary for hubtests, but will have to go.
 // DownloadDataIfNeeded downloads the data set for the item.
 func DownloadDataIfNeeded(ctx context.Context, hub *cwhub.Hub, item *cwhub.Item, force bool) (bool, error) {
-	itemFilePath, err := item.InstallPath()
+	itemFile, err := os.Open(item.State.LocalPath)
 	if err != nil {
-		return false, err
-	}
-
-	itemFile, err := os.Open(itemFilePath)
-	if err != nil {
-		return false, fmt.Errorf("while opening %s: %w", itemFilePath, err)
+		return false, fmt.Errorf("while opening %s: %w", item.State.LocalPath, err)
 	}
 
 	defer itemFile.Close()
 
 	needReload, err := downloadDataSet(ctx, hub.GetDataDir(), force, itemFile)
 	if err != nil {
-		return needReload, fmt.Errorf("while downloading data for %s: %w", itemFilePath, err)
+		return needReload, fmt.Errorf("while downloading data for %s: %w", item.State.LocalPath, err)
 	}
 
 	return needReload, nil

pkg/hubops/disable.go

@@ -10,12 +10,7 @@ import (
 
 // RemoveInstallLink removes the item's symlink between the installation directory and the local hub.
 func RemoveInstallLink(i *cwhub.Item) error {
-	syml, err := i.InstallPath()
-	if err != nil {
-		return err
-	}
-
-	stat, err := os.Lstat(syml)
+	stat, err := os.Lstat(i.State.LocalPath)
 	if err != nil {
 		return err
 	}
@@ -25,7 +20,7 @@ func RemoveInstallLink(i *cwhub.Item) error {
 		return fmt.Errorf("%s isn't managed by hub", i.Name)
 	}
 
-	hubpath, err := os.Readlink(syml)
+	hubpath, err := os.Readlink(i.State.LocalPath)
 	if err != nil {
 		return fmt.Errorf("while reading symlink: %w", err)
 	}
@@ -39,7 +34,7 @@ func RemoveInstallLink(i *cwhub.Item) error {
 		return fmt.Errorf("%s isn't managed by hub", i.Name)
 	}
 
-	if err := os.Remove(syml); err != nil {
+	if err := os.Remove(i.State.LocalPath); err != nil {
 		return fmt.Errorf("while removing symlink: %w", err)
 	}
 

test/bats/20_hub.bats

@@ -104,6 +104,36 @@ teardown() {
     assert_stderr --partial "crowdsecurity/sshd is tainted by missing parsers:crowdsecurity/sshd-logs"
 }
 
+@test "an install symlink can have a different name than the items it points to" {
+    rune -0 cscli scenarios install crowdsecurity/ssh-bf
+    rune -0 cscli scenarios inspect crowdsecurity/ssh-bf -o json
+    rune -0 jq -r '.local_path' <(output)
+    rune -0 mv "$output" "$CONFIG_DIR/scenarios/newname.yaml"
+    rune -0 cscli hub list -o json
+    rune -0 jq -r '.scenarios.[].name' <(output)
+    assert_output 'crowdsecurity/ssh-bf'
+
+    rune -0 cscli scenarios inspect crowdsecurity/ssh-bf -o json
+    rune -0 jq -r '.installed' <(output)
+    assert_output true
+
+    rune -0 cscli scenarios remove crowdsecurity/ssh-bf
+    assert_output - <<-EOT
+	Action plan:
+	❌ disable
+	 scenarios: crowdsecurity/ssh-bf
+
+	disabling scenarios:crowdsecurity/ssh-bf
+
+	$RELOAD_MESSAGE
+	EOT
+    refute_stderr
+
+    rune -0 cscli scenarios inspect crowdsecurity/ssh-bf -o json
+    rune -0 jq -r '.installed' <(output)
+    assert_output false
+}
+
 @test "cscli hub update" {
     rm -f "$INDEX_PATH"
     rune -0 cscli hub update