detectors/feature: consistent naming and godoc

worker/detectors/feature/dpkg/dpkg_test.go

@@ -22,7 +22,8 @@ import (
 	"github.com/coreos/clair/worker/detectors/feature"
 )
 
-var dpkgPackagesTests = []feature.FeatureVersionTest{
+func TestDpkgFeatureDetection(t *testing.T) {
+	testData := []feature.TestData{
 		// Test an Ubuntu dpkg status file
 		{
 			FeatureVersions: []database.FeatureVersion{
@@ -46,6 +47,5 @@ var dpkgPackagesTests = []feature.FeatureVersionTest{
 		},
 	}
 
-func TestDpkgFeaturesDetector(t *testing.T) {
-	feature.TestFeaturesDetector(t, &DpkgFeaturesDetector{}, dpkgPackagesTests)
+	feature.TestDetector(t, &DpkgFeaturesDetector{}, testData)
 }

worker/detectors/feature/rpm/rpm_test.go

@@ -22,7 +22,8 @@ import (
 	"github.com/coreos/clair/worker/detectors/feature"
 )
 
-var rpmPackagesTests = []feature.FeatureVersionTest{
+func TestRpmFeatureDetection(t *testing.T) {
+	testData := []feature.TestData{
 		// Test a CentOS 7 RPM database
 		// Memo: Use the following command on a RPM-based system to shrink a database: rpm -qa --qf "%{NAME}\n" |tail -n +3| xargs rpm -e --justdb
 		{
@@ -44,6 +45,5 @@ var rpmPackagesTests = []feature.FeatureVersionTest{
 		},
 	}
 
-func TestRpmFeaturesDetector(t *testing.T) {
-	feature.TestFeaturesDetector(t, &RpmFeaturesDetector{}, rpmPackagesTests)
+	feature.TestDetector(t, &RpmFeaturesDetector{}, testData)
 }

worker/detectors/feature/test.go

@@ -1,4 +1,4 @@
-// Copyright 2015 clair authors
+// Copyright 2016 clair authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package feature implements utilities common to implementations of
+// FeatureDetector.
 package feature
 
 import (
@@ -25,22 +27,28 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-type FeatureVersionTest struct {
-	FeatureVersions []database.FeatureVersion
+// TestData represents the data used to test an implementation of
+// FeatureDetector.
+type TestData struct {
 	Data            map[string][]byte
+	FeatureVersions []database.FeatureVersion
 }
 
+// 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)
 	d, _ := ioutil.ReadFile(filepath.Join(filepath.Dir(filename)) + "/" + name)
 	return d
 }
 
-func TestFeaturesDetector(t *testing.T, detector detectors.FeaturesDetector, tests []FeatureVersionTest) {
-	for _, test := range tests {
-		featureVersions, err := detector.Detect(test.Data)
-		if assert.Nil(t, err) && assert.Len(t, featureVersions, len(test.FeatureVersions)) {
-			for _, expectedFeatureVersion := range test.FeatureVersions {
+// TestDetector runs a detector on each provided instance of TestData and
+// asserts the ouput to be equal to the expected output.
+func TestDetector(t *testing.T, detector detectors.FeaturesDetector, testData []TestData) {
+	for _, td := range testData {
+		featureVersions, err := detector.Detect(td.Data)
+		if assert.Nil(t, err) && assert.Len(t, featureVersions, len(td.FeatureVersions)) {
+			for _, expectedFeatureVersion := range td.FeatureVersions {
 				assert.Contains(t, featureVersions, expectedFeatureVersion)
 			}
 		}