1. Featurefmt testing code is moved to featurefmttest package. 2. Featurefmt now can be tested against a csv file, which contains the expected package information result.master
Sida Chen
6 years ago
parent
3fe894c5ad
commit
1c40e7d016
@ -0,0 +1,56 @@
|
||||
package featurefmt
|
||||
|
||||
import (
|
||||
"github.com/coreos/clair/database"
|
||||
"github.com/deckarep/golang-set"
|
||||
)
|
||||
|
||||
// PackageInfo is the extracted raw information from the package managers that
|
||||
// can be converted to a feature.
|
||||
type PackageInfo struct {
|
||||
PackageName string
|
||||
PackageVersion string
|
||||
SourceName string
|
||||
SourceVersion string
|
||||
}
|
||||
|
||||
// Reset defaults the internal string fields to empty strings.
|
||||
func (pkg *PackageInfo) Reset() {
|
||||
pkg.PackageName = ""
|
||||
pkg.PackageVersion = ""
|
||||
pkg.SourceName = ""
|
||||
pkg.SourceVersion = ""
|
||||
}
|
||||
|
||||
func (pkg *PackageInfo) asFeature(versionFormat string) database.Feature {
|
||||
feature := database.Feature{
|
||||
Name: pkg.PackageName,
|
||||
Version: pkg.PackageVersion,
|
||||
VersionFormat: versionFormat,
|
||||
}
|
||||
|
||||
if pkg.SourceName != "" {
|
||||
parent := database.Feature{
|
||||
Name: pkg.SourceName,
|
||||
Version: pkg.SourceVersion,
|
||||
VersionFormat: versionFormat,
|
||||
}
|
||||
|
||||
if parent != feature {
|
||||
feature.Parent = &parent
|
||||
}
|
||||
}
|
||||
|
||||
return feature
|
||||
}
|
||||
|
||||
// PackageSetToFeatures converts a package set to feature slice
|
||||
func PackageSetToFeatures(versionFormat string, pkgs mapset.Set) []database.Feature {
|
||||
features := make([]database.Feature, 0, pkgs.Cardinality())
|
||||
for pkg := range pkgs.Iter() {
|
||||
p := pkg.(PackageInfo)
|
||||
features = append(features, p.asFeature(versionFormat))
|
||||
}
|
||||
|
||||
return features
|
||||
}
|
||||
@ -0,0 +1,118 @@
|
||||
// Copyright 2018 clair 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.
|
||||
|
||||
// Package featurefmt contains utility functions for featurefmt tests
|
||||
package featurefmt
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/coreos/clair/database"
|
||||
"github.com/coreos/clair/pkg/tarutil"
|
||||
)
|
||||
|
||||
// LoadFileForTest can be used in order to obtain the []byte contents of a file
|
||||
// that is meant to be used for test data.
|
||||
func LoadFileForTest(name string) []byte {
|
||||
_, filename, _, _ := runtime.Caller(0)
|
||||
path := filepath.Join(filepath.Dir(filename), name)
|
||||
d, err := ioutil.ReadFile(path)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
return d
|
||||
}
|
||||
|
||||
func loadTestFiles(testFilePaths map[string]string) tarutil.FilesMap {
|
||||
m := tarutil.FilesMap{}
|
||||
for tarPath, fsPath := range testFilePaths {
|
||||
m[tarPath] = LoadFileForTest(fsPath)
|
||||
}
|
||||
|
||||
return m
|
||||
}
|
||||
|
||||
// TestCase is used by the RunTest function to execute.
|
||||
type TestCase struct {
|
||||
Name string
|
||||
FilePaths map[string]string
|
||||
ExpectedResult []PackageInfo
|
||||
}
|
||||
|
||||
// RunTest runs a featurefmt test by loading the package info database files and
|
||||
// the expected packages.
|
||||
func RunTest(t *testing.T, test TestCase, lister Lister, expectedVersionFormat string) {
|
||||
t.Run(test.Name, func(t *testing.T) {
|
||||
filesMap := loadTestFiles(test.FilePaths)
|
||||
expected := test.ExpectedResult
|
||||
features, err := lister.ListFeatures(filesMap)
|
||||
require.Nil(t, err)
|
||||
visited := map[PackageInfo]bool{}
|
||||
// we only enforce the unique packages to match, the result features
|
||||
// should be always deduplicated.
|
||||
for _, pkg := range expected {
|
||||
visited[pkg] = false
|
||||
}
|
||||
|
||||
assert.Len(t, features, len(visited))
|
||||
for _, f := range features {
|
||||
assert.Equal(t, expectedVersionFormat, f.VersionFormat)
|
||||
if f.Parent != nil {
|
||||
// currently we don't have more than 2 levels deep features.
|
||||
assert.Equal(t, expectedVersionFormat, f.Parent.VersionFormat)
|
||||
}
|
||||
|
||||
pkg := convertToPackageInfo(&f)
|
||||
if ok, found := visited[pkg]; ok {
|
||||
assert.Fail(t, "duplicated features is not allowed", "feature=%#v", f, pkg)
|
||||
} else if !found {
|
||||
assert.Fail(t, "unexpected feature", "feature = %#v", pkg)
|
||||
}
|
||||
|
||||
visited[pkg] = true
|
||||
}
|
||||
|
||||
missingPackages := []PackageInfo{}
|
||||
for pkg, ok := range visited {
|
||||
if !ok {
|
||||
missingPackages = append(missingPackages, pkg)
|
||||
}
|
||||
}
|
||||
|
||||
assert.Len(t, missingPackages, 0, "missing packages")
|
||||
})
|
||||
}
|
||||
|
||||
func convertToPackageInfo(feature *database.Feature) PackageInfo {
|
||||
pkg := PackageInfo{
|
||||
PackageName: feature.Name,
|
||||
PackageVersion: feature.Version,
|
||||
}
|
||||
|
||||
// Since in the actual package manager metadata file, there's no explicit
|
||||
// tree structure, the features are converted to compare the metadata only.
|
||||
if feature.Parent != nil {
|
||||
pkg.SourceName = feature.Parent.Name
|
||||
pkg.SourceVersion = feature.Parent.Version
|
||||
}
|
||||
|
||||
return pkg
|
||||
}
|
||||
Loading…
Reference in new issue