Files
Charon/backend/internal/crowdsec/hub_sync_test.go
GitHub Actions 25082778c9 feat(cerberus): integrate Cerberus security features (WAF, ACLs, rate limiting, CrowdSec)
- Implement GeoIPService for IP-to-country lookups with comprehensive error handling.
- Add tests for GeoIPService covering various scenarios including invalid IPs and database loading.
- Extend AccessListService to handle GeoIP service integration, including graceful degradation when GeoIP service is unavailable.
- Introduce new tests for AccessListService to validate geo ACL behavior and country code parsing.
- Update SecurityService to include new fields for WAF configuration and enhance decision logging functionality.
- Add extensive tests for SecurityService covering rule set management and decision logging.
- Create a detailed Security Coverage QA Plan to ensure 100% code coverage for security-related functionality.
2025-12-12 17:56:30 +00:00

1190 lines
40 KiB
Go

package crowdsec
import (
"archive/tar"
"bytes"
"compress/gzip"
"context"
"errors"
"fmt"
"io"
"net/http"
"os"
"path/filepath"
"strings"
"testing"
"time"
"github.com/stretchr/testify/require"
)
type roundTripperFunc func(*http.Request) (*http.Response, error)
type recordingExec struct {
outputs map[string][]byte
errors map[string]error
calls []string
}
func (f roundTripperFunc) RoundTrip(req *http.Request) (*http.Response, error) {
return f(req)
}
func (r *recordingExec) Execute(ctx context.Context, name string, args ...string) ([]byte, error) {
cmd := name + " " + strings.Join(args, " ")
r.calls = append(r.calls, cmd)
if err, ok := r.errors[cmd]; ok {
return nil, err
}
if out, ok := r.outputs[cmd]; ok {
return out, nil
}
return nil, fmt.Errorf("unexpected command: %s", cmd)
}
func newResponse(status int, body string) *http.Response {
return &http.Response{StatusCode: status, Body: io.NopCloser(strings.NewReader(body)), Header: make(http.Header)}
}
func makeTarGz(t *testing.T, files map[string]string) []byte {
t.Helper()
buf := &bytes.Buffer{}
gw := gzip.NewWriter(buf)
tw := tar.NewWriter(gw)
for name, content := range files {
hdr := &tar.Header{Name: name, Mode: 0o644, Size: int64(len(content))}
require.NoError(t, tw.WriteHeader(hdr))
_, err := tw.Write([]byte(content))
require.NoError(t, err)
}
require.NoError(t, tw.Close())
require.NoError(t, gw.Close())
return buf.Bytes()
}
func readFixture(t *testing.T, name string) string {
t.Helper()
data, err := os.ReadFile(filepath.Join("testdata", name))
require.NoError(t, err)
return string(data)
}
func TestFetchIndexPrefersCSCLI(t *testing.T) {
exec := &recordingExec{outputs: map[string][]byte{"cscli hub list -o json": []byte(`{"collections":[{"name":"crowdsecurity/test","description":"desc","version":"1.0"}]}`)}}
svc := NewHubService(exec, nil, t.TempDir())
svc.HTTPClient = nil
idx, err := svc.FetchIndex(context.Background())
require.NoError(t, err)
require.Len(t, idx.Items, 1)
require.Equal(t, "crowdsecurity/test", idx.Items[0].Name)
require.Contains(t, exec.calls, "cscli hub list -o json")
}
func TestFetchIndexFallbackHTTP(t *testing.T) {
exec := &recordingExec{errors: map[string]error{"cscli hub list -o json": fmt.Errorf("boom")}}
cacheDir := t.TempDir()
svc := NewHubService(exec, nil, cacheDir)
svc.HubBaseURL = "http://example.com"
indexBody := readFixture(t, "hub_index.json")
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
if req.URL.String() == "http://example.com"+defaultHubIndexPath {
resp := newResponse(http.StatusOK, indexBody)
resp.Header.Set("Content-Type", "application/json")
return resp, nil
}
return newResponse(http.StatusNotFound, ""), nil
})}
idx, err := svc.FetchIndex(context.Background())
require.NoError(t, err)
require.Len(t, idx.Items, 1)
require.Equal(t, "crowdsecurity/demo", idx.Items[0].Name)
}
func TestFetchIndexHTTPRejectsRedirect(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
svc.HubBaseURL = "http://hub.example"
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
resp := newResponse(http.StatusMovedPermanently, "")
resp.Header.Set("Location", "https://hub.crowdsec.net/")
return resp, nil
})}
_, err := svc.fetchIndexHTTP(context.Background())
require.Error(t, err)
require.Contains(t, err.Error(), "redirect")
}
func TestFetchIndexHTTPRejectsHTML(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
htmlBody := readFixture(t, "hub_index_html.html")
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
resp := newResponse(http.StatusOK, htmlBody)
resp.Header.Set("Content-Type", "text/html")
return resp, nil
})}
_, err := svc.fetchIndexHTTP(context.Background())
require.Error(t, err)
require.Contains(t, err.Error(), "HTML")
}
func TestFetchIndexHTTPFallsBackToDefaultHub(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
svc.HubBaseURL = "https://hub.crowdsec.net"
calls := make([]string, 0)
indexBody := `{"items":[{"name":"crowdsecurity/demo","title":"Demo","type":"collection"}]}`
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
calls = append(calls, req.URL.String())
switch req.URL.String() {
case "https://hub.crowdsec.net/api/index.json":
resp := newResponse(http.StatusMovedPermanently, "")
resp.Header.Set("Location", "https://hub-data.crowdsec.net/api/index.json")
return resp, nil
case "https://hub-data.crowdsec.net/api/index.json":
resp := newResponse(http.StatusOK, indexBody)
resp.Header.Set("Content-Type", "application/json")
return resp, nil
default:
return newResponse(http.StatusNotFound, ""), nil
}
})}
idx, err := svc.fetchIndexHTTP(context.Background())
require.NoError(t, err)
require.Len(t, idx.Items, 1)
require.Equal(t, "crowdsecurity/demo", idx.Items[0].Name)
require.Equal(t, []string{"https://hub.crowdsec.net/api/index.json", "https://hub-data.crowdsec.net/api/index.json"}, calls)
}
func TestFetchIndexFallsBackToMirrorOnForbidden(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
svc.HubBaseURL = "https://hub-data.crowdsec.net"
svc.MirrorBaseURL = defaultHubMirrorBaseURL
calls := make([]string, 0)
indexBody := `{"items":[{"name":"crowdsecurity/demo","title":"Demo","type":"collection"}]}`
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
calls = append(calls, req.URL.String())
switch req.URL.String() {
case "https://hub-data.crowdsec.net/api/index.json":
return newResponse(http.StatusForbidden, ""), nil
case defaultHubMirrorBaseURL + "/.index.json":
resp := newResponse(http.StatusOK, indexBody)
resp.Header.Set("Content-Type", "application/json")
return resp, nil
default:
return newResponse(http.StatusNotFound, ""), nil
}
})}
idx, err := svc.FetchIndex(context.Background())
require.NoError(t, err)
require.Len(t, idx.Items, 1)
require.Contains(t, calls, defaultHubMirrorBaseURL+"/.index.json")
}
func TestPullCachesPreview(t *testing.T) {
cacheDir := t.TempDir()
dataDir := filepath.Join(t.TempDir(), "crowdsec")
cache, err := NewHubCache(cacheDir, time.Hour)
require.NoError(t, err)
archiveBytes := makeTarGz(t, map[string]string{"config.yaml": "value: 1"})
svc := NewHubService(nil, cache, dataDir)
svc.HubBaseURL = "http://example.com"
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
switch req.URL.String() {
case "http://example.com" + defaultHubIndexPath:
return newResponse(http.StatusOK, `{"items":[{"name":"crowdsecurity/demo","title":"Demo","description":"desc","type":"collection","etag":"etag1","download_url":"http://example.com/demo.tgz","preview_url":"http://example.com/demo.yaml"}]}`), nil
case "http://example.com/demo.yaml":
return newResponse(http.StatusOK, "preview-body"), nil
case "http://example.com/demo.tgz":
return &http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(bytes.NewReader(archiveBytes)), Header: make(http.Header)}, nil
default:
return newResponse(http.StatusNotFound, ""), nil
}
})}
res, err := svc.Pull(context.Background(), "crowdsecurity/demo")
require.NoError(t, err)
require.Equal(t, "preview-body", res.Preview)
require.NotEmpty(t, res.Meta.CacheKey)
require.FileExists(t, res.Meta.ArchivePath)
}
func TestApplyUsesCacheWhenCSCLIFails(t *testing.T) {
cache, err := NewHubCache(t.TempDir(), time.Hour)
require.NoError(t, err)
dataDir := filepath.Join(t.TempDir(), "data")
archive := makeTarGz(t, map[string]string{"a/b.yaml": "ok: 1"})
_, err = cache.Store(context.Background(), "crowdsecurity/demo", "etag1", "hub", "preview", archive)
require.NoError(t, err)
exec := &recordingExec{outputs: map[string][]byte{"cscli version": []byte("v"), "cscli hub update": []byte("ok")}, errors: map[string]error{"cscli hub install crowdsecurity/demo": fmt.Errorf("install failed")}}
svc := NewHubService(exec, cache, dataDir)
res, err := svc.Apply(context.Background(), "crowdsecurity/demo")
require.NoError(t, err)
require.False(t, res.UsedCSCLI)
require.Equal(t, "applied", res.Status)
require.FileExists(t, filepath.Join(dataDir, "a", "b.yaml"))
}
func TestApplyRollsBackOnBadArchive(t *testing.T) {
cache, err := NewHubCache(t.TempDir(), time.Hour)
require.NoError(t, err)
baseDir := filepath.Join(t.TempDir(), "data")
require.NoError(t, os.MkdirAll(baseDir, 0o755))
keep := filepath.Join(baseDir, "keep.txt")
require.NoError(t, os.WriteFile(keep, []byte("before"), 0o644))
badArchive := makeTarGz(t, map[string]string{"../evil.txt": "boom"})
_, err = cache.Store(context.Background(), "crowdsecurity/demo", "etag1", "hub", "preview", badArchive)
require.NoError(t, err)
svc := NewHubService(nil, cache, baseDir)
_, err = svc.Apply(context.Background(), "crowdsecurity/demo")
require.Error(t, err)
content, readErr := os.ReadFile(keep)
require.NoError(t, readErr)
require.Equal(t, "before", string(content))
}
func TestApplyUsesCacheWhenCscliMissing(t *testing.T) {
cache, err := NewHubCache(t.TempDir(), time.Hour)
require.NoError(t, err)
dataDir := filepath.Join(t.TempDir(), "data")
archive := makeTarGz(t, map[string]string{"config.yml": "hello: world"})
_, err = cache.Store(context.Background(), "crowdsecurity/demo", "etag1", "hub", "preview", archive)
require.NoError(t, err)
svc := NewHubService(nil, cache, dataDir)
res, err := svc.Apply(context.Background(), "crowdsecurity/demo")
require.NoError(t, err)
require.False(t, res.UsedCSCLI)
require.FileExists(t, filepath.Join(dataDir, "config.yml"))
}
func TestPullReturnsCachedPreviewWithoutNetwork(t *testing.T) {
cache, err := NewHubCache(t.TempDir(), time.Hour)
require.NoError(t, err)
archive := makeTarGz(t, map[string]string{"demo.yaml": "x: 1"})
_, err = cache.Store(context.Background(), "crowdsecurity/demo", "etag1", "hub", "cached-preview", archive)
require.NoError(t, err)
svc := NewHubService(nil, cache, t.TempDir())
svc.HTTPClient = nil
res, err := svc.Pull(context.Background(), "crowdsecurity/demo")
require.NoError(t, err)
require.Equal(t, "cached-preview", res.Preview)
}
func TestPullEvictsExpiredCacheAndRefreshes(t *testing.T) {
cache, err := NewHubCache(t.TempDir(), time.Second)
require.NoError(t, err)
fixed := time.Now().Add(-2 * time.Second)
cache.nowFn = func() time.Time { return fixed }
archive := makeTarGz(t, map[string]string{"a.yaml": "v: 1"})
initial, err := cache.Store(context.Background(), "crowdsecurity/demo", "etag1", "hub", "old", archive)
require.NoError(t, err)
cache.nowFn = func() time.Time { return fixed.Add(3 * time.Second) }
svc := NewHubService(nil, cache, t.TempDir())
svc.HubBaseURL = "http://example.com"
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
switch req.URL.String() {
case "http://example.com" + defaultHubIndexPath:
return newResponse(http.StatusOK, `{"items":[{"name":"crowdsecurity/demo","title":"Demo","description":"desc","type":"collection","etag":"etag2","download_url":"http://example.com/demo.tgz","preview_url":"http://example.com/demo.yaml"}]}`), nil
case "http://example.com/demo.yaml":
return newResponse(http.StatusOK, "fresh-preview"), nil
case "http://example.com/demo.tgz":
return &http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(bytes.NewReader(archive)), Header: make(http.Header)}, nil
default:
return newResponse(http.StatusNotFound, ""), nil
}
})}
res, err := svc.Pull(context.Background(), "crowdsecurity/demo")
require.NoError(t, err)
require.NotEqual(t, initial.CacheKey, res.Meta.CacheKey)
require.Equal(t, "fresh-preview", res.Preview)
}
func TestPullFallsBackToArchivePreview(t *testing.T) {
cache, err := NewHubCache(t.TempDir(), time.Hour)
require.NoError(t, err)
archive := makeTarGz(t, map[string]string{"scenarios/demo.yaml": "title: demo"})
svc := NewHubService(nil, cache, t.TempDir())
svc.HubBaseURL = "http://example.com"
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
if req.URL.String() == "http://example.com"+defaultHubIndexPath {
return newResponse(http.StatusOK, `{"items":[{"name":"crowdsecurity/demo","title":"Demo","etag":"etag1","download_url":"http://example.com/demo.tgz","preview_url":"http://example.com/demo.yaml"}]}`), nil
}
if req.URL.String() == "http://example.com/demo.yaml" {
return newResponse(http.StatusInternalServerError, ""), nil
}
if req.URL.String() == "http://example.com/demo.tgz" {
return &http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(bytes.NewReader(archive)), Header: make(http.Header)}, nil
}
return newResponse(http.StatusNotFound, ""), nil
})}
res, err := svc.Pull(context.Background(), "crowdsecurity/demo")
require.NoError(t, err)
require.Contains(t, res.Preview, "title: demo")
}
func TestPullFallsBackToMirrorArchiveOnForbidden(t *testing.T) {
cache, err := NewHubCache(t.TempDir(), time.Hour)
require.NoError(t, err)
dataDir := filepath.Join(t.TempDir(), "crowdsec")
archiveBytes := makeTarGz(t, map[string]string{"config.yml": "foo: bar"})
svc := NewHubService(nil, cache, dataDir)
svc.HubBaseURL = "https://primary.example"
svc.MirrorBaseURL = defaultHubMirrorBaseURL
calls := make([]string, 0)
indexBody := `{"items":[{"name":"crowdsecurity/demo","title":"Demo","etag":"etag1","type":"collection"}]}`
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
calls = append(calls, req.URL.String())
switch req.URL.String() {
case "https://primary.example/api/index.json":
resp := newResponse(http.StatusOK, indexBody)
resp.Header.Set("Content-Type", "application/json")
return resp, nil
case "https://primary.example/crowdsecurity/demo.tgz":
return newResponse(http.StatusForbidden, ""), nil
case "https://primary.example/crowdsecurity/demo.yaml":
return newResponse(http.StatusForbidden, ""), nil
case defaultHubMirrorBaseURL + "/.index.json":
resp := newResponse(http.StatusOK, indexBody)
resp.Header.Set("Content-Type", "application/json")
return resp, nil
case defaultHubMirrorBaseURL + "/crowdsecurity/demo.tgz":
return &http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(bytes.NewReader(archiveBytes)), Header: make(http.Header)}, nil
case defaultHubMirrorBaseURL + "/crowdsecurity/demo.yaml":
return newResponse(http.StatusOK, "mirror-preview"), nil
case defaultHubBaseURL + "/api/index.json":
return newResponse(http.StatusInternalServerError, ""), nil
default:
return newResponse(http.StatusNotFound, ""), nil
}
})}
res, err := svc.Pull(context.Background(), "crowdsecurity/demo")
require.NoError(t, err)
require.Contains(t, calls, defaultHubMirrorBaseURL+"/crowdsecurity/demo.tgz")
require.Equal(t, "mirror-preview", res.Preview)
require.FileExists(t, res.Meta.ArchivePath)
}
func TestFetchWithLimitRejectsLargePayload(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
big := bytes.Repeat([]byte("a"), int(maxArchiveSize+10))
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
return &http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(bytes.NewReader(big)), Header: make(http.Header)}, nil
})}
_, err := svc.fetchWithLimitFromURL(context.Background(), "http://example.com/large.tgz")
require.Error(t, err)
require.Contains(t, err.Error(), "payload too large")
}
func makeSymlinkTar(t *testing.T, linkName string) []byte {
t.Helper()
buf := &bytes.Buffer{}
gw := gzip.NewWriter(buf)
tw := tar.NewWriter(gw)
hdr := &tar.Header{Name: linkName, Mode: 0o777, Typeflag: tar.TypeSymlink, Linkname: "target"}
require.NoError(t, tw.WriteHeader(hdr))
require.NoError(t, tw.Close())
require.NoError(t, gw.Close())
return buf.Bytes()
}
func TestExtractTarGzRejectsSymlink(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
archive := makeSymlinkTar(t, "bad.symlink")
err := svc.extractTarGz(context.Background(), archive, filepath.Join(t.TempDir(), "data"))
require.Error(t, err)
require.Contains(t, err.Error(), "symlinks not allowed")
}
func TestExtractTarGzRejectsAbsolutePath(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
buf := &bytes.Buffer{}
gw := gzip.NewWriter(buf)
tw := tar.NewWriter(gw)
hdr := &tar.Header{Name: "/etc/passwd", Mode: 0o644, Size: int64(len("x"))}
require.NoError(t, tw.WriteHeader(hdr))
_, err := tw.Write([]byte("x"))
require.NoError(t, err)
require.NoError(t, tw.Close())
require.NoError(t, gw.Close())
err = svc.extractTarGz(context.Background(), buf.Bytes(), filepath.Join(t.TempDir(), "data"))
require.Error(t, err)
require.Contains(t, err.Error(), "unsafe path")
}
func TestFetchIndexHTTPError(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
return newResponse(http.StatusServiceUnavailable, ""), nil
})}
_, err := svc.fetchIndexHTTP(context.Background())
require.Error(t, err)
}
func TestPullValidatesSlugAndMissingPreset(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
_, err := svc.Pull(context.Background(), " ")
require.Error(t, err)
cache, cacheErr := NewHubCache(t.TempDir(), time.Hour)
require.NoError(t, cacheErr)
svc.Cache = cache
svc.HubBaseURL = "http://hub.example"
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
return newResponse(http.StatusOK, `{"items":[{"name":"crowdsecurity/other","title":"Other","description":"d","type":"collection"}]}`), nil
})}
_, err = svc.Pull(context.Background(), "crowdsecurity/missing")
require.Error(t, err)
}
func TestFetchPreviewRequiresURL(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
_, err := svc.fetchPreview(context.Background(), nil)
require.Error(t, err)
}
func TestFetchWithLimitRequiresClient(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
svc.HTTPClient = nil
_, err := svc.fetchWithLimitFromURL(context.Background(), "http://example.com/demo.tgz")
require.Error(t, err)
}
func TestRunCSCLIRejectsUnsafeSlug(t *testing.T) {
exec := &recordingExec{}
svc := NewHubService(exec, nil, t.TempDir())
err := svc.runCSCLI(context.Background(), "../bad")
require.Error(t, err)
}
func TestApplyUsesCSCLISuccess(t *testing.T) {
cache, err := NewHubCache(t.TempDir(), time.Hour)
require.NoError(t, err)
_, err = cache.Store(context.Background(), "crowdsecurity/demo", "etag1", "hub", "preview", makeTarGz(t, map[string]string{"config.yml": "val: 1"}))
require.NoError(t, err)
exec := &recordingExec{outputs: map[string][]byte{
"cscli version": []byte("v1"),
"cscli hub update": []byte("ok"),
"cscli hub install crowdsecurity/demo": []byte("installed"),
}}
svc := NewHubService(exec, cache, t.TempDir())
res, applyErr := svc.Apply(context.Background(), "crowdsecurity/demo")
require.NoError(t, applyErr)
require.True(t, res.UsedCSCLI)
require.Equal(t, "applied", res.Status)
}
func TestFetchIndexCSCLIParseError(t *testing.T) {
exec := &recordingExec{outputs: map[string][]byte{"cscli hub list -o json": []byte("not-json")}}
svc := NewHubService(exec, nil, t.TempDir())
svc.HubBaseURL = "http://hub.example"
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
return newResponse(http.StatusInternalServerError, ""), nil
})}
_, err := svc.FetchIndex(context.Background())
require.Error(t, err)
}
func TestFetchWithLimitStatusError(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
svc.HubBaseURL = "http://hub.example"
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
return newResponse(http.StatusNotFound, ""), nil
})}
_, err := svc.fetchWithLimitFromURL(context.Background(), "http://hub.example/demo.tgz")
require.Error(t, err)
}
func TestApplyRollsBackWhenCacheMissing(t *testing.T) {
baseDir := t.TempDir()
dataDir := filepath.Join(baseDir, "crowdsec")
require.NoError(t, os.MkdirAll(dataDir, 0o755))
require.NoError(t, os.WriteFile(filepath.Join(dataDir, "keep.txt"), []byte("before"), 0o644))
svc := NewHubService(nil, nil, dataDir)
res, err := svc.Apply(context.Background(), "crowdsecurity/demo")
require.Error(t, err)
require.Contains(t, err.Error(), "cache unavailable")
require.NotEmpty(t, res.BackupPath)
require.Equal(t, "failed", res.Status)
content, readErr := os.ReadFile(filepath.Join(dataDir, "keep.txt"))
require.NoError(t, readErr)
require.Equal(t, "before", string(content))
}
func TestNormalizeHubBaseURL(t *testing.T) {
tests := []struct {
name string
input string
want string
}{
{"empty uses default", "", defaultHubBaseURL},
{"whitespace uses default", " ", defaultHubBaseURL},
{"removes trailing slash", "https://hub.crowdsec.net/", "https://hub.crowdsec.net"},
{"removes multiple trailing slashes", "https://hub.crowdsec.net///", "https://hub.crowdsec.net"},
{"trims spaces", " https://hub.crowdsec.net ", "https://hub.crowdsec.net"},
{"no slash unchanged", "https://hub.crowdsec.net", "https://hub.crowdsec.net"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := normalizeHubBaseURL(tt.input)
require.Equal(t, tt.want, got)
})
}
}
func TestBuildIndexURL(t *testing.T) {
tests := []struct {
name string
base string
want string
}{
{"empty base uses default", "", defaultHubBaseURL + defaultHubIndexPath},
{"standard base appends path", "https://hub.crowdsec.net", "https://hub.crowdsec.net" + defaultHubIndexPath},
{"trailing slash removed", "https://hub.crowdsec.net/", "https://hub.crowdsec.net" + defaultHubIndexPath},
{"direct json url unchanged", "https://custom.hub/index.json", "https://custom.hub/index.json"},
{"case insensitive json", "https://custom.hub/INDEX.JSON", "https://custom.hub/INDEX.JSON"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := buildIndexURL(tt.base)
require.Equal(t, tt.want, got)
})
}
}
func TestUniqueStrings(t *testing.T) {
tests := []struct {
name string
input []string
want []string
}{
{"empty slice", []string{}, []string{}},
{"no duplicates", []string{"a", "b", "c"}, []string{"a", "b", "c"}},
{"with duplicates", []string{"a", "b", "a", "c", "b"}, []string{"a", "b", "c"}},
{"all duplicates", []string{"x", "x", "x"}, []string{"x"}},
{"preserves order", []string{"z", "a", "m", "a"}, []string{"z", "a", "m"}},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := uniqueStrings(tt.input)
require.Equal(t, tt.want, got)
})
}
}
func TestFirstNonEmpty(t *testing.T) {
tests := []struct {
name string
values []string
want string
}{
{"first non-empty", []string{"", "second", "third"}, "second"},
{"all empty", []string{"", "", ""}, ""},
{"first is non-empty", []string{"first", "second"}, "first"},
{"whitespace treated as empty", []string{" ", "second"}, "second"},
{"whitespace with content", []string{" hello ", "second"}, " hello "},
{"empty slice", []string{}, ""},
{"tabs and newlines", []string{"\t\n", "third"}, "third"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := firstNonEmpty(tt.values...)
require.Equal(t, tt.want, got)
})
}
}
func TestCleanShellArg(t *testing.T) {
tests := []struct {
name string
input string
safe bool
}{
{"clean slug", "crowdsecurity/demo", true},
{"with dash", "crowdsecurity/demo-v1", true},
{"with underscore", "crowdsecurity/demo_parser", true},
{"with dot", "crowdsecurity/demo.yaml", true},
{"path traversal", "../etc/passwd", false},
{"absolute path", "/etc/passwd", false},
{"backslash converted", "bad\\path", true},
{"colon not allowed", "demo:1.0", false},
{"semicolon", "foo;rm -rf", false},
{"pipe", "foo|bar", false},
{"ampersand", "foo&bar", false},
{"backtick", "foo`cmd`", false},
{"dollar", "foo$var", false},
{"parenthesis", "foo()", false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := cleanShellArg(tt.input)
if tt.safe {
require.NotEmpty(t, got, "safe input should not be empty")
// Note: backslashes are converted to forward slashes by filepath.Clean
} else {
require.Empty(t, got, "unsafe input should return empty string")
}
})
}
}
func TestHasCSCLI(t *testing.T) {
t.Run("cscli available", func(t *testing.T) {
exec := &recordingExec{outputs: map[string][]byte{"cscli version": []byte("v1.5.0")}}
svc := NewHubService(exec, nil, t.TempDir())
got := svc.hasCSCLI(context.Background())
require.True(t, got)
})
t.Run("cscli not found", func(t *testing.T) {
exec := &recordingExec{errors: map[string]error{"cscli version": fmt.Errorf("executable not found")}}
svc := NewHubService(exec, nil, t.TempDir())
got := svc.hasCSCLI(context.Background())
require.False(t, got)
})
}
func TestFindPreviewFileFromArchive(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
t.Run("finds yaml in archive", func(t *testing.T) {
archive := makeTarGz(t, map[string]string{
"scenarios/test.yaml": "name: test-scenario\ndescription: test",
})
preview := svc.findPreviewFile(archive)
require.Contains(t, preview, "test-scenario")
})
t.Run("returns empty for no yaml", func(t *testing.T) {
archive := makeTarGz(t, map[string]string{
"readme.txt": "no yaml here",
})
preview := svc.findPreviewFile(archive)
require.Empty(t, preview)
})
t.Run("returns empty for invalid archive", func(t *testing.T) {
preview := svc.findPreviewFile([]byte("not a gzip archive"))
require.Empty(t, preview)
})
}
func TestApplyWithCopyBasedBackup(t *testing.T) {
cache, err := NewHubCache(t.TempDir(), time.Hour)
require.NoError(t, err)
dataDir := filepath.Join(t.TempDir(), "data")
require.NoError(t, os.MkdirAll(dataDir, 0o755))
require.NoError(t, os.WriteFile(filepath.Join(dataDir, "existing.txt"), []byte("old data"), 0o644))
// Create subdirectory with files
subDir := filepath.Join(dataDir, "subdir")
require.NoError(t, os.MkdirAll(subDir, 0o755))
require.NoError(t, os.WriteFile(filepath.Join(subDir, "nested.txt"), []byte("nested"), 0o644))
archive := makeTarGz(t, map[string]string{"new/config.yaml": "new: config"})
_, err = cache.Store(context.Background(), "test/preset", "etag1", "hub", "preview", archive)
require.NoError(t, err)
svc := NewHubService(nil, cache, dataDir)
res, err := svc.Apply(context.Background(), "test/preset")
require.NoError(t, err)
require.Equal(t, "applied", res.Status)
require.NotEmpty(t, res.BackupPath)
// Verify backup was created with copy-based approach
require.FileExists(t, filepath.Join(res.BackupPath, "existing.txt"))
require.FileExists(t, filepath.Join(res.BackupPath, "subdir", "nested.txt"))
// Verify new config was applied
require.FileExists(t, filepath.Join(dataDir, "new", "config.yaml"))
}
func TestBackupExistingHandlesDeviceBusy(t *testing.T) {
dataDir := filepath.Join(t.TempDir(), "data")
require.NoError(t, os.MkdirAll(dataDir, 0o755))
require.NoError(t, os.WriteFile(filepath.Join(dataDir, "file.txt"), []byte("content"), 0o644))
svc := NewHubService(nil, nil, dataDir)
backupPath := dataDir + ".backup.test"
// Even if rename fails, copy-based backup should work
err := svc.backupExisting(backupPath)
require.NoError(t, err)
require.FileExists(t, filepath.Join(backupPath, "file.txt"))
}
func TestCopyFile(t *testing.T) {
tmpDir := t.TempDir()
srcFile := filepath.Join(tmpDir, "source.txt")
dstFile := filepath.Join(tmpDir, "dest.txt")
// Create source file
content := []byte("test file content")
require.NoError(t, os.WriteFile(srcFile, content, 0o644))
// Test successful copy
err := copyFile(srcFile, dstFile)
require.NoError(t, err)
require.FileExists(t, dstFile)
// Verify content
dstContent, err := os.ReadFile(dstFile)
require.NoError(t, err)
require.Equal(t, content, dstContent)
// Test copy non-existent file
err = copyFile(filepath.Join(tmpDir, "nonexistent.txt"), dstFile)
require.Error(t, err)
require.Contains(t, err.Error(), "open src")
// Test copy to invalid destination
err = copyFile(srcFile, filepath.Join(tmpDir, "nonexistent", "dest.txt"))
require.Error(t, err)
require.Contains(t, err.Error(), "create dst")
}
func TestCopyDir(t *testing.T) {
tmpDir := t.TempDir()
srcDir := filepath.Join(tmpDir, "source")
dstDir := filepath.Join(tmpDir, "dest")
// Create source directory structure
require.NoError(t, os.MkdirAll(filepath.Join(srcDir, "subdir"), 0o755))
require.NoError(t, os.WriteFile(filepath.Join(srcDir, "file1.txt"), []byte("file1"), 0o644))
require.NoError(t, os.WriteFile(filepath.Join(srcDir, "subdir", "file2.txt"), []byte("file2"), 0o644))
// Create destination directory
require.NoError(t, os.MkdirAll(dstDir, 0o755))
// Test successful copy
err := copyDir(srcDir, dstDir)
require.NoError(t, err)
// Verify files were copied
require.FileExists(t, filepath.Join(dstDir, "file1.txt"))
require.FileExists(t, filepath.Join(dstDir, "subdir", "file2.txt"))
// Verify content
content1, err := os.ReadFile(filepath.Join(dstDir, "file1.txt"))
require.NoError(t, err)
require.Equal(t, []byte("file1"), content1)
content2, err := os.ReadFile(filepath.Join(dstDir, "subdir", "file2.txt"))
require.NoError(t, err)
require.Equal(t, []byte("file2"), content2)
// Test copy non-existent directory
err = copyDir(filepath.Join(tmpDir, "nonexistent"), dstDir)
require.Error(t, err)
require.Contains(t, err.Error(), "stat src")
// Test copy file as directory (should fail)
fileNotDir := filepath.Join(tmpDir, "file.txt")
require.NoError(t, os.WriteFile(fileNotDir, []byte("test"), 0o644))
err = copyDir(fileNotDir, dstDir)
require.Error(t, err)
require.Contains(t, err.Error(), "not a directory")
}
func TestFetchIndexHTTPAcceptsTextPlain(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
indexBody := `{"items":[{"name":"crowdsecurity/demo","title":"Demo","type":"collection"}]}`
svc.HTTPClient = &http.Client{Transport: roundTripperFunc(func(req *http.Request) (*http.Response, error) {
resp := newResponse(http.StatusOK, indexBody)
resp.Header.Set("Content-Type", "text/plain; charset=utf-8")
return resp, nil
})}
idx, err := svc.fetchIndexHTTP(context.Background())
require.NoError(t, err)
require.Len(t, idx.Items, 1)
require.Equal(t, "crowdsecurity/demo", idx.Items[0].Name)
}
// ============================================
// emptyDir Tests
// ============================================
func TestEmptyDir(t *testing.T) {
t.Run("empties directory with files", func(t *testing.T) {
dir := t.TempDir()
require.NoError(t, os.WriteFile(filepath.Join(dir, "file1.txt"), []byte("content1"), 0o644))
require.NoError(t, os.WriteFile(filepath.Join(dir, "file2.txt"), []byte("content2"), 0o644))
err := emptyDir(dir)
require.NoError(t, err)
// Directory should still exist
require.DirExists(t, dir)
// But be empty
entries, err := os.ReadDir(dir)
require.NoError(t, err)
require.Empty(t, entries)
})
t.Run("empties directory with subdirectories", func(t *testing.T) {
dir := t.TempDir()
subDir := filepath.Join(dir, "subdir")
require.NoError(t, os.MkdirAll(subDir, 0o755))
require.NoError(t, os.WriteFile(filepath.Join(subDir, "nested.txt"), []byte("nested"), 0o644))
err := emptyDir(dir)
require.NoError(t, err)
require.DirExists(t, dir)
entries, err := os.ReadDir(dir)
require.NoError(t, err)
require.Empty(t, entries)
})
t.Run("handles non-existent directory", func(t *testing.T) {
err := emptyDir(filepath.Join(t.TempDir(), "nonexistent"))
require.NoError(t, err, "should not error on non-existent directory")
})
t.Run("handles empty directory", func(t *testing.T) {
dir := t.TempDir()
err := emptyDir(dir)
require.NoError(t, err)
require.DirExists(t, dir)
})
}
// ============================================
// extractTarGz Tests
// ============================================
func TestExtractTarGz(t *testing.T) {
svc := NewHubService(nil, nil, t.TempDir())
t.Run("extracts valid archive", func(t *testing.T) {
targetDir := t.TempDir()
archive := makeTarGz(t, map[string]string{
"file1.txt": "content1",
"subdir/file2.txt": "content2",
})
err := svc.extractTarGz(context.Background(), archive, targetDir)
require.NoError(t, err)
require.FileExists(t, filepath.Join(targetDir, "file1.txt"))
require.FileExists(t, filepath.Join(targetDir, "subdir", "file2.txt"))
content1, err := os.ReadFile(filepath.Join(targetDir, "file1.txt"))
require.NoError(t, err)
require.Equal(t, "content1", string(content1))
})
t.Run("rejects path traversal", func(t *testing.T) {
targetDir := t.TempDir()
// Create malicious archive with path traversal
buf := &bytes.Buffer{}
gw := gzip.NewWriter(buf)
tw := tar.NewWriter(gw)
hdr := &tar.Header{Name: "../escape.txt", Mode: 0o644, Size: 7}
require.NoError(t, tw.WriteHeader(hdr))
_, err := tw.Write([]byte("escaped"))
require.NoError(t, err)
require.NoError(t, tw.Close())
require.NoError(t, gw.Close())
err = svc.extractTarGz(context.Background(), buf.Bytes(), targetDir)
require.Error(t, err)
require.Contains(t, err.Error(), "unsafe path")
})
t.Run("rejects symlinks", func(t *testing.T) {
targetDir := t.TempDir()
buf := &bytes.Buffer{}
gw := gzip.NewWriter(buf)
tw := tar.NewWriter(gw)
hdr := &tar.Header{
Name: "symlink",
Mode: 0o777,
Size: 0,
Typeflag: tar.TypeSymlink,
Linkname: "/etc/passwd",
}
require.NoError(t, tw.WriteHeader(hdr))
require.NoError(t, tw.Close())
require.NoError(t, gw.Close())
err := svc.extractTarGz(context.Background(), buf.Bytes(), targetDir)
require.Error(t, err)
require.Contains(t, err.Error(), "symlinks not allowed")
})
t.Run("handles corrupted gzip", func(t *testing.T) {
targetDir := t.TempDir()
err := svc.extractTarGz(context.Background(), []byte("not a gzip"), targetDir)
require.Error(t, err)
require.Contains(t, err.Error(), "gunzip")
})
t.Run("handles context cancellation", func(t *testing.T) {
targetDir := t.TempDir()
archive := makeTarGz(t, map[string]string{"file.txt": "content"})
ctx, cancel := context.WithCancel(context.Background())
cancel() // Cancel immediately
err := svc.extractTarGz(ctx, archive, targetDir)
require.Error(t, err)
require.ErrorIs(t, err, context.Canceled)
})
t.Run("creates nested directories", func(t *testing.T) {
targetDir := t.TempDir()
archive := makeTarGz(t, map[string]string{
"a/b/c/deep.txt": "deep content",
})
err := svc.extractTarGz(context.Background(), archive, targetDir)
require.NoError(t, err)
require.FileExists(t, filepath.Join(targetDir, "a", "b", "c", "deep.txt"))
})
}
// ============================================
// backupExisting Tests
// ============================================
func TestBackupExisting(t *testing.T) {
t.Run("handles non-existent directory", func(t *testing.T) {
dataDir := filepath.Join(t.TempDir(), "nonexistent")
svc := NewHubService(nil, nil, dataDir)
backupPath := dataDir + ".backup"
err := svc.backupExisting(backupPath)
require.NoError(t, err)
require.NoDirExists(t, backupPath)
})
t.Run("creates backup of existing directory", func(t *testing.T) {
dataDir := t.TempDir()
require.NoError(t, os.WriteFile(filepath.Join(dataDir, "config.txt"), []byte("config data"), 0o644))
subDir := filepath.Join(dataDir, "subdir")
require.NoError(t, os.MkdirAll(subDir, 0o755))
require.NoError(t, os.WriteFile(filepath.Join(subDir, "nested.txt"), []byte("nested data"), 0o644))
svc := NewHubService(nil, nil, dataDir)
backupPath := filepath.Join(t.TempDir(), "backup")
err := svc.backupExisting(backupPath)
require.NoError(t, err)
// Verify backup exists
require.FileExists(t, filepath.Join(backupPath, "config.txt"))
require.FileExists(t, filepath.Join(backupPath, "subdir", "nested.txt"))
})
t.Run("backup contents match original", func(t *testing.T) {
dataDir := t.TempDir()
originalContent := "important config"
require.NoError(t, os.WriteFile(filepath.Join(dataDir, "config.txt"), []byte(originalContent), 0o644))
svc := NewHubService(nil, nil, dataDir)
backupPath := filepath.Join(t.TempDir(), "backup")
err := svc.backupExisting(backupPath)
require.NoError(t, err)
backupContent, err := os.ReadFile(filepath.Join(backupPath, "config.txt"))
require.NoError(t, err)
require.Equal(t, originalContent, string(backupContent))
})
}
// ============================================
// rollback Tests
// ============================================
func TestRollback(t *testing.T) {
t.Run("rollback with backup", func(t *testing.T) {
parentDir := t.TempDir()
dataDir := filepath.Join(parentDir, "data")
backupPath := filepath.Join(parentDir, "backup")
// Create backup first
require.NoError(t, os.MkdirAll(backupPath, 0o755))
require.NoError(t, os.WriteFile(filepath.Join(backupPath, "backed_up.txt"), []byte("backup content"), 0o644))
// Create data dir with different content
require.NoError(t, os.MkdirAll(dataDir, 0o755))
require.NoError(t, os.WriteFile(filepath.Join(dataDir, "current.txt"), []byte("current content"), 0o644))
svc := NewHubService(nil, nil, dataDir)
err := svc.rollback(backupPath)
require.NoError(t, err)
// Data dir should now have backup contents
require.FileExists(t, filepath.Join(dataDir, "backed_up.txt"))
// Backup path should no longer exist (renamed to dataDir)
require.NoDirExists(t, backupPath)
})
t.Run("rollback with empty backup path", func(t *testing.T) {
dataDir := t.TempDir()
svc := NewHubService(nil, nil, dataDir)
err := svc.rollback("")
require.NoError(t, err)
})
t.Run("rollback with non-existent backup", func(t *testing.T) {
dataDir := t.TempDir()
svc := NewHubService(nil, nil, dataDir)
err := svc.rollback(filepath.Join(t.TempDir(), "nonexistent"))
require.NoError(t, err)
})
}
// ============================================
// hubHTTPError Tests
// ============================================
func TestHubHTTPErrorError(t *testing.T) {
t.Run("error with inner error", func(t *testing.T) {
inner := errors.New("connection refused")
err := hubHTTPError{
url: "https://hub.example.com/index.json",
statusCode: 503,
inner: inner,
fallback: true,
}
msg := err.Error()
require.Contains(t, msg, "https://hub.example.com/index.json")
require.Contains(t, msg, "503")
require.Contains(t, msg, "connection refused")
})
t.Run("error without inner error", func(t *testing.T) {
err := hubHTTPError{
url: "https://hub.example.com/index.json",
statusCode: 404,
inner: nil,
fallback: false,
}
msg := err.Error()
require.Contains(t, msg, "https://hub.example.com/index.json")
require.Contains(t, msg, "404")
require.NotContains(t, msg, "nil")
})
}
func TestHubHTTPErrorUnwrap(t *testing.T) {
t.Run("unwrap returns inner error", func(t *testing.T) {
inner := errors.New("underlying error")
err := hubHTTPError{
url: "https://hub.example.com",
statusCode: 500,
inner: inner,
}
unwrapped := err.Unwrap()
require.Equal(t, inner, unwrapped)
})
t.Run("unwrap returns nil when no inner", func(t *testing.T) {
err := hubHTTPError{
url: "https://hub.example.com",
statusCode: 500,
inner: nil,
}
unwrapped := err.Unwrap()
require.Nil(t, unwrapped)
})
t.Run("errors.Is works through Unwrap", func(t *testing.T) {
inner := context.Canceled
err := hubHTTPError{
url: "https://hub.example.com",
statusCode: 0,
inner: inner,
}
// errors.Is should work through Unwrap chain
require.True(t, errors.Is(err, context.Canceled))
})
}
func TestHubHTTPErrorCanFallback(t *testing.T) {
t.Run("returns true when fallback is true", func(t *testing.T) {
err := hubHTTPError{
url: "https://hub.example.com",
statusCode: 503,
fallback: true,
}
require.True(t, err.CanFallback())
})
t.Run("returns false when fallback is false", func(t *testing.T) {
err := hubHTTPError{
url: "https://hub.example.com",
statusCode: 404,
fallback: false,
}
require.False(t, err.CanFallback())
})
}