Skip to content

fix: slim down the CrowdSec export, validate imports by parsing, and fix import UI text #1542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Wikid82 merged 10 commits into from
Oct 10, 2026
Merged

fix: slim down the CrowdSec export, validate imports by parsing, and fix import UI text #1542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9622f7e
test(e2e): add fixme specs for the CrowdSec export and import changes
Wikid82 Oct 10, 2026
5ef90f4
fix: slim down the CrowdSec configuration export
Wikid82 Oct 10, 2026
0858c32
fix: validate CrowdSec configuration files by parsing them
Wikid82 Oct 10, 2026
270f85a
fix: offer only .tar.gz in the CrowdSec import and translate Check Now
Wikid82 Oct 10, 2026
6dcc71d
docs: describe the CrowdSec export and import behavior
Wikid82 Oct 10, 2026
a6416f8
docs: update QA report for the CrowdSec export and import changes
Wikid82 Oct 10, 2026
fac0df3
test: cover YAML alias expansion limits in CrowdSec config validation
Wikid82 Oct 10, 2026
ec9dbb7
docs: clarify what a CrowdSec configuration export contains
Wikid82 Oct 10, 2026
9b09b9f
ci: fix the Codecov configuration so it is actually applied
Wikid82 Oct 10, 2026
159dc7d
ci: validate codecov.yml in the Codecov parity guard
Wikid82 Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/quality-checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,19 @@ jobs:
run: |
bash scripts/ci/check-codecov-trigger-parity.sh

- name: Install bats + shellcheck
run: |
set -euo pipefail
sudo apt-get update
sudo apt-get install -y bats shellcheck

- name: shellcheck (shell severity=error)
run: |
shellcheck --severity=error scripts/ci/check-codecov-trigger-parity.sh

- name: bats
run: bats scripts/tests/check-codecov-trigger-parity.bats

toolchain-key-tests:
name: Toolchain key / freshness-guard scripts (bats)
runs-on: ubuntu-latest
Expand Down
110 changes: 25 additions & 85 deletions backend/internal/api/handlers/crowdsec_archive_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,85 +5,37 @@ import (
"compress/gzip"
"os"
"path/filepath"
"strings"
"testing"
)

// TestDetectArchiveFormat tests the detectArchiveFormat helper function.
func TestDetectArchiveFormat(t *testing.T) {
// TestRequireTarGz tests the requireTarGz helper function.
func TestRequireTarGz(t *testing.T) {
tests := []struct {
name string
path string
wantFormat string
wantErr bool
errContains string
name string
path string
wantErr bool
}{
{
name: "tar.gz extension",
path: "/path/to/archive.tar.gz",
wantFormat: "tar.gz",
wantErr: false,
},
{
name: "TAR.GZ uppercase",
path: "/path/to/ARCHIVE.TAR.GZ",
wantFormat: "tar.gz",
wantErr: false,
},
{
name: "zip extension",
path: "/path/to/archive.zip",
wantFormat: "zip",
wantErr: false,
},
{
name: "ZIP uppercase",
path: "/path/to/ARCHIVE.ZIP",
wantFormat: "zip",
wantErr: false,
},
{
name: "unsupported extension",
path: "/path/to/archive.rar",
wantFormat: "",
wantErr: true,
errContains: "unsupported format",
},
{
name: "no extension",
path: "/path/to/archive",
wantFormat: "",
wantErr: true,
errContains: "unsupported format",
},
{
name: "txt extension",
path: "/path/to/archive.txt",
wantFormat: "",
wantErr: true,
errContains: "unsupported format",
},
{"tar.gz extension", "/path/to/archive.tar.gz", false},
{"TAR.GZ uppercase", "/path/to/ARCHIVE.TAR.GZ", false},
{"zip extension", "/path/to/archive.zip", true},
{"ZIP uppercase", "/path/to/ARCHIVE.ZIP", true},
{"tgz extension", "/path/to/archive.tgz", true},
{"rar extension", "/path/to/archive.rar", true},
{"no extension", "/path/to/archive", true},
{"txt extension", "/path/to/archive.txt", true},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
format, err := detectArchiveFormat(tt.path)
if tt.wantErr {
if err == nil {
t.Errorf("detectArchiveFormat() expected error, got nil")
return
}
if tt.errContains != "" && !strings.Contains(err.Error(), tt.errContains) {
t.Errorf("detectArchiveFormat() error = %v, want error containing %q", err, tt.errContains)
err := requireTarGz(tt.path)
if !tt.wantErr {
if err != nil {
t.Errorf("requireTarGz() unexpected error = %v", err)
}
return
}
if err != nil {
t.Errorf("detectArchiveFormat() unexpected error = %v", err)
return
}
if format != tt.wantFormat {
t.Errorf("detectArchiveFormat() = %q, want %q", format, tt.wantFormat)
if err == nil || err.Error() != "only .tar.gz archives are supported" {
t.Errorf("requireTarGz() error = %v, want the fixed archive format message", err)
}
})
}
Expand Down Expand Up @@ -149,7 +101,7 @@ func TestCalculateUncompressedSize(t *testing.T) {

// Test calculateUncompressedSize
expectedSize := int64(len(testContent) + len(content2))
size, err := calculateUncompressedSize(archivePath, "tar.gz")
size, err := calculateUncompressedSize(archivePath)
if err != nil {
t.Errorf("calculateUncompressedSize() unexpected error = %v", err)
return
Expand All @@ -158,14 +110,8 @@ func TestCalculateUncompressedSize(t *testing.T) {
t.Errorf("calculateUncompressedSize() = %d, want %d", size, expectedSize)
}

// Test with unsupported format
_, err = calculateUncompressedSize(archivePath, "unsupported")
if err == nil {
t.Error("calculateUncompressedSize() expected error for unsupported format")
}

// Test with non-existent file
_, err = calculateUncompressedSize("/nonexistent/path.tar.gz", "tar.gz")
_, err = calculateUncompressedSize("/nonexistent/path.tar.gz")
if err == nil {
t.Error("calculateUncompressedSize() expected error for non-existent file")
}
Expand Down Expand Up @@ -225,7 +171,7 @@ func TestListArchiveContents(t *testing.T) {
}

// Test listArchiveContents
contents, err := listArchiveContents(archivePath, "tar.gz")
contents, err := listArchiveContents(archivePath)
if err != nil {
t.Errorf("listArchiveContents() unexpected error = %v", err)
return
Expand Down Expand Up @@ -253,14 +199,8 @@ func TestListArchiveContents(t *testing.T) {
t.Errorf("listArchiveContents() returned %d files, want %d", len(contents), len(expectedFiles))
}

// Test with unsupported format
_, err = listArchiveContents(archivePath, "unsupported")
if err == nil {
t.Error("listArchiveContents() expected error for unsupported format")
}

// Test with non-existent file
_, err = listArchiveContents("/nonexistent/path.tar.gz", "tar.gz")
_, err = listArchiveContents("/nonexistent/path.tar.gz")
if err == nil {
t.Error("listArchiveContents() expected error for non-existent file")
}
Expand Down Expand Up @@ -320,8 +260,8 @@ func TestConfigArchiveValidator_Validate(t *testing.T) {
t.Fatalf("Failed to create dummy file: %v", writeErr)
}
err = validator.Validate(unsupportedPath)
if err == nil {
t.Error("Validate() expected error for unsupported format")
if err == nil || err.Error() != "only .tar.gz archives are supported" {
t.Errorf("Validate() error = %v, want the fixed archive format message", err)
}
}

Expand Down
4 changes: 2 additions & 2 deletions backend/internal/api/handlers/crowdsec_archive_validation_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,13 @@ func TestConfigArchiveValidator_InvalidFormats(t *testing.T) {
name: "txt file",
filename: "test.txt",
content: "not an archive",
wantErr: "unsupported format",
wantErr: "only .tar.gz archives are supported",
},
{
name: "rar file",
filename: "test.rar",
content: "Rar!\x1a\x07\x00",
wantErr: "unsupported format",
wantErr: "only .tar.gz archives are supported",
},
}

Expand Down
Loading
Loading