Skip to content

Commit

Permalink
Add requirement checker test data
Browse files Browse the repository at this point in the history
  • Loading branch information
@koplas
koplas committed Dec 6, 2024
1 parent 5b6af7a commit 68bd046
Show file tree
Hide file tree
Showing 7 changed files with 1,299 additions and 97 deletions.
147 changes: 50 additions & 97 deletions cmd/csaf_checker/processor_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,99 +9,54 @@
package main

import (
"fmt"
"bytes"
"encoding/json"
"net/http/httptest"
"os"
"reflect"
"testing"
"text/template"

"github.com/gocsaf/csaf/v3/internal/testutil"
"github.com/gocsaf/csaf/v3/util"
)

func getBaseRequirements(url string) []Requirement {
return []Requirement{
{
Num: 1,
Description: "Valid CSAF documents",
Messages: []Message{{Type: 1, Text: "No remote validator configured"}, {Type: 0, Text: "All advisories validated fine against the schema."}},
}, {
Num: 2,
Description: "Filename",
Messages: []Message{{Type: 0, Text: "All found filenames are conforming."}}},
{
Num: 3,
Description: "TLS",
Messages: []Message{{Type: 0, Text: "All tested URLs were HTTPS."}}},
{
Num: 4,
Description: "TLP:WHITE",
Messages: []Message{{Type: 0, Text: "All advisories labeled TLP:WHITE were freely accessible."}}},
{
Num: 5,
Description: "TLP:AMBER and TLP:RED",
Messages: []Message{
{Type: 0, Text: "No advisories labeled TLP:AMBER or TLP:RED tested for accessibility."}}},
{
Num: 6,
Description: "Redirects",
Messages: []Message{{Type: 0, Text: "No redirections found."}}},
{
Num: 7,
Description: "provider-metadata.json",
Messages: []Message{{Type: 0, Text: "Found good provider metadata."}}},
{
Num: 8,
Description: "security.txt",
Messages: []Message{{Type: 0, Text: "Performed no test of security.txt since the direct url of the provider-metadata.json was used."}}},
{
Num: 9,
Description: "/.well-known/csaf/provider-metadata.json",
Messages: []Message{{Type: 0, Text: "Performed no test on whether the provider-metadata.json is available under the .well-known path since the direct url of the provider-metadata.json was used."}}},
{
Num: 10,
Description: "DNS path",
Messages: []Message{{Type: 0, Text: "Performed no test on the contents of https://csaf.data.security.DOMAIN since the direct url of the provider-metadata.json was used."}}},
{
Num: 11,
Description: "One folder per year",
Messages: []Message{{Type: 2, Text: fmt.Sprintf("No year folder found in %s/white/avendor-advisory-0004.json", url)}}},
{
Num: 12,
Description: "index.txt",
Messages: []Message{{Type: 0, Text: fmt.Sprintf("Found %s/white/index.txt", url)}}},
{
Num: 13,
Description: "changes.csv",
Messages: []Message{{Type: 0, Text: fmt.Sprintf("Found %s/white/changes.csv", url)}}},
{
Num: 14,
Description: "Directory listings",
Messages: []Message{{Type: 0, Text: "All directory listings are valid."}}},
{
Num: 15,
Description: "ROLIE feed",
Messages: []Message{{Type: 2, Text: "ROLIE feed based distribution was not used."}}},
{
Num: 16,
Description: "ROLIE service document",
Messages: []Message{{Type: 1, Text: "No ROLIE service document found."}}},
{
Num: 17,
Description: "ROLIE category document",
Messages: []Message{{Type: 1, Text: "No ROLIE category document found."}}},
{
Num: 18,
Description: "Integrity",
Messages: []Message{{Type: 0, Text: "All checksums match."}}},
{
Num: 19,
Description: "Signatures",
Messages: []Message{{Type: 0, Text: "All signatures verified."}}},
{
Num: 20,
Description: "Public OpenPGP Key",
Messages: []Message{{Type: 0, Text: "1 public OpenPGP key(s) loaded."}}},
func getRequirementTestData(t *testing.T, params testutil.ProviderParams, directoryProvider bool) []Requirement {
path := "../../testdata/processor-requirements/"
if params.EnableSha256 {
path += "sha256-"
}
if params.EnableSha512 {
path += "sha512-"
}
if directoryProvider {
path += "directory"
} else {
path += "rolie"
}
path += ".json"

content, err := os.ReadFile(path)
if err != nil {
t.Fatal(err)
}

tmplt, err := template.New("base").Parse(string(content))
if err != nil {
t.Fatal(err)
}

var output bytes.Buffer
err = tmplt.Execute(&output, params)
if err != nil {
t.Fatal(err)
}
var requirement []Requirement
err = json.Unmarshal(output.Bytes(), &requirement)
if err != nil {
t.Fatal(err)
}
return requirement
}

func TestShaMarking(t *testing.T) {
Expand All @@ -110,49 +65,42 @@ func TestShaMarking(t *testing.T) {
directoryProvider bool
enableSha256 bool
enableSha512 bool
expected func(string) []Requirement
}{
{
name: "deliver sha256 and sha512",
directoryProvider: false,
enableSha256: true,
enableSha512: true,
expected: getBaseRequirements,
},
{
name: "only deliver sha256",
directoryProvider: false,
enableSha256: true,
enableSha512: false,
expected: getBaseRequirements,
},
{
name: "only deliver sha512",
directoryProvider: false,
enableSha256: false,
enableSha512: true,
expected: getBaseRequirements,
},
{
name: "only deliver sha256 and sha512, directory provider",
name: "deliver sha256 and sha512, directory provider",
directoryProvider: true,
enableSha256: true,
enableSha512: true,
expected: getBaseRequirements,
},
{
name: "only deliver sha256, directory provider",
directoryProvider: true,
enableSha256: true,
enableSha512: false,
expected: getBaseRequirements,
},
{
name: "only deliver sha512, directory provider",
directoryProvider: true,
enableSha256: false,
enableSha512: true,
expected: getBaseRequirements,
},
}

Expand Down Expand Up @@ -191,11 +139,16 @@ func TestShaMarking(t *testing.T) {
if err != nil {
t.Errorf("SHA marking %v: Expected no error, got: %v", test.name, err)
}
expected := test.expected(serverURL)
for i, got := range report.Domains[0].Requirements {
want := expected[i]
if !reflect.DeepEqual(*got, want) {
t.Errorf("SHA marking %v: Expected %v, got %v", test.name, want, *got)
expected := getRequirementTestData(t,
testutil.ProviderParams{
URL: serverURL,
EnableSha256: test.enableSha256,
EnableSha512: test.enableSha512,
},
test.directoryProvider)
for i, want := range report.Domains[0].Requirements {
if !reflect.DeepEqual(expected[i], *want) {
t.Errorf("SHA marking %v: Expected %v, got %v", test.name, *want, expected[i])
}
}

Expand Down
Loading

0 comments on commit 68bd046

Please sign in to comment.