Skip to content

Commit

Permalink
ext: feature detector -> featurefmt
Browse files Browse the repository at this point in the history
  • Loading branch information
jzelinskie committed Jan 23, 2017
1 parent 71a8b54 commit cda3d48
Show file tree
Hide file tree
Showing 15 changed files with 191 additions and 201 deletions.
12 changes: 6 additions & 6 deletions cmd/clair/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,13 @@ import (
"github.com/coreos/clair"
"github.com/coreos/clair/config"

// Register database driver.
_ "github.com/coreos/clair/database/pgsql"

// Register extensions.
_ "github.com/coreos/clair/ext/featurefmt/apk"
_ "github.com/coreos/clair/ext/featurefmt/dpkg"
_ "github.com/coreos/clair/ext/featurefmt/rpm"
_ "github.com/coreos/clair/ext/featurens/alpinerelease"
_ "github.com/coreos/clair/ext/featurens/aptsources"
_ "github.com/coreos/clair/ext/featurens/lsbrelease"
Expand All @@ -40,12 +46,6 @@ import (
_ "github.com/coreos/clair/ext/vulnsrc/oracle"
_ "github.com/coreos/clair/ext/vulnsrc/rhel"
_ "github.com/coreos/clair/ext/vulnsrc/ubuntu"

_ "github.com/coreos/clair/worker/detectors/feature/apk"
_ "github.com/coreos/clair/worker/detectors/feature/dpkg"
_ "github.com/coreos/clair/worker/detectors/feature/rpm"

_ "github.com/coreos/clair/database/pgsql"
)

var log = capnslog.NewPackageLogger("github.com/coreos/clair/cmd/clair", "main")
Expand Down
18 changes: 10 additions & 8 deletions worker/detectors/feature/apk/apk.go → ext/featurefmt/apk/apk.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2016 clair authors
// Copyright 2017 clair authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package apk implements a featurefmt.Lister for APK packages.
package apk

import (
Expand All @@ -21,21 +22,22 @@ import (
"github.com/coreos/pkg/capnslog"

"github.com/coreos/clair/database"
"github.com/coreos/clair/ext/featurefmt"
"github.com/coreos/clair/ext/versionfmt"
"github.com/coreos/clair/ext/versionfmt/dpkg"
"github.com/coreos/clair/worker/detectors"
"github.com/coreos/clair/pkg/tarutil"
)

var log = capnslog.NewPackageLogger("github.com/coreos/clair", "worker/detectors/packages")
var log = capnslog.NewPackageLogger("github.com/coreos/clair", "ext/featurefmt/apk")

func init() {
detectors.RegisterFeaturesDetector("apk", &detector{})
featurefmt.RegisterLister("apk", &lister{})
}

type detector struct{}
type lister struct{}

func (d *detector) Detect(data map[string][]byte) ([]database.FeatureVersion, error) {
file, exists := data["lib/apk/db/installed"]
func (l lister) ListFeatures(files tarutil.FilesMap) ([]database.FeatureVersion, error) {
file, exists := files["lib/apk/db/installed"]
if !exists {
return []database.FeatureVersion{}, nil
}
Expand Down Expand Up @@ -83,6 +85,6 @@ func (d *detector) Detect(data map[string][]byte) ([]database.FeatureVersion, er
return pkgs, nil
}

func (d *detector) GetRequiredFiles() []string {
func (l lister) RequiredFilenames() []string {
return []string{"lib/apk/db/installed"}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2016 clair authors
// Copyright 2017 clair authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -18,11 +18,12 @@ import (
"testing"

"github.com/coreos/clair/database"
"github.com/coreos/clair/worker/detectors/feature"
"github.com/coreos/clair/ext/featurefmt"
"github.com/coreos/clair/pkg/tarutil"
)

func TestAPKFeatureDetection(t *testing.T) {
testData := []feature.TestData{
testData := []featurefmt.TestData{
{
FeatureVersions: []database.FeatureVersion{
{
Expand Down Expand Up @@ -70,10 +71,10 @@ func TestAPKFeatureDetection(t *testing.T) {
Version: "0.7-r0",
},
},
Data: map[string][]byte{
"lib/apk/db/installed": feature.LoadFileForTest("apk/testdata/installed"),
Files: tarutil.FilesMap{
"lib/apk/db/installed": featurefmt.LoadFileForTest("apk/testdata/installed"),
},
},
}
feature.TestDetector(t, &detector{}, testData)
featurefmt.TestLister(t, &lister{}, testData)
}
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2015 clair authors
// Copyright 2017 clair authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package dpkg implements a featurefmt.Lister for dpkg packages.
package dpkg

import (
Expand All @@ -22,28 +23,27 @@ import (
"github.com/coreos/pkg/capnslog"

"github.com/coreos/clair/database"
"github.com/coreos/clair/ext/featurefmt"
"github.com/coreos/clair/ext/versionfmt"
"github.com/coreos/clair/ext/versionfmt/dpkg"
"github.com/coreos/clair/worker/detectors"
"github.com/coreos/clair/pkg/tarutil"
)

var (
log = capnslog.NewPackageLogger("github.com/coreos/clair", "worker/detectors/packages")
log = capnslog.NewPackageLogger("github.com/coreos/clair", "ext/featurefmt/dpkg")

dpkgSrcCaptureRegexp = regexp.MustCompile(`Source: (?P<name>[^\s]*)( \((?P<version>.*)\))?`)
dpkgSrcCaptureRegexpNames = dpkgSrcCaptureRegexp.SubexpNames()
)

// DpkgFeaturesDetector implements FeaturesDetector and detects dpkg packages
type DpkgFeaturesDetector struct{}
type lister struct{}

func init() {
detectors.RegisterFeaturesDetector("dpkg", &DpkgFeaturesDetector{})
featurefmt.RegisterLister("dpkg", &lister{})
}

// Detect detects packages using var/lib/dpkg/status from the input data
func (detector *DpkgFeaturesDetector) Detect(data map[string][]byte) ([]database.FeatureVersion, error) {
f, hasFile := data["var/lib/dpkg/status"]
func (l lister) ListFeatures(files tarutil.FilesMap) ([]database.FeatureVersion, error) {
f, hasFile := files["var/lib/dpkg/status"]
if !hasFile {
return []database.FeatureVersion{}, nil
}
Expand Down Expand Up @@ -116,8 +116,6 @@ func (detector *DpkgFeaturesDetector) Detect(data map[string][]byte) ([]database
return packages, nil
}

// GetRequiredFiles returns the list of files required for Detect, without
// leading /
func (detector *DpkgFeaturesDetector) GetRequiredFiles() []string {
func (l lister) RequiredFilenames() []string {
return []string{"var/lib/dpkg/status"}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2015 clair authors
// Copyright 2017 clair authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -18,11 +18,12 @@ import (
"testing"

"github.com/coreos/clair/database"
"github.com/coreos/clair/worker/detectors/feature"
"github.com/coreos/clair/ext/featurefmt"
"github.com/coreos/clair/pkg/tarutil"
)

func TestDpkgFeatureDetection(t *testing.T) {
testData := []feature.TestData{
testData := []featurefmt.TestData{
// Test an Ubuntu dpkg status file
{
FeatureVersions: []database.FeatureVersion{
Expand All @@ -40,11 +41,11 @@ func TestDpkgFeatureDetection(t *testing.T) {
Version: "5.1.1-12ubuntu1", // The version comes from the "Source:" line
},
},
Data: map[string][]byte{
"var/lib/dpkg/status": feature.LoadFileForTest("dpkg/testdata/status"),
Files: tarutil.FilesMap{
"var/lib/dpkg/status": featurefmt.LoadFileForTest("dpkg/testdata/status"),
},
},
}

feature.TestDetector(t, &DpkgFeaturesDetector{}, testData)
featurefmt.TestLister(t, &lister{}, testData)
}
File renamed without changes.
126 changes: 126 additions & 0 deletions ext/featurefmt/driver.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
// Copyright 2017 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 exposes functions to dynamically register methods for
// determining the features present in an image layer.
package featurefmt

import (
"io/ioutil"
"path/filepath"
"runtime"
"sync"
"testing"

"github.com/coreos/clair/database"
"github.com/coreos/clair/pkg/tarutil"
"github.com/stretchr/testify/assert"
)

var (
listersM sync.RWMutex
listers = make(map[string]Lister)
)

// Lister represents an ability to list the features present in an image layer.
type Lister interface {
// ListFeatures produces a list of FeatureVersions present in an image layer.
ListFeatures(tarutil.FilesMap) ([]database.FeatureVersion, error)

// RequiredFilenames returns the list of files required to be in the FilesMap
// provided to the ListFeatures method.
//
// Filenames must not begin with "/".
RequiredFilenames() []string
}

// RegisterLister makes a Lister available by the provided name.
//
// If called twice with the same name, the name is blank, or if the provided
// Lister is nil, this function panics.
func RegisterLister(name string, l Lister) {
if name == "" {
panic("featurefmt: could not register a Lister with an empty name")
}
if l == nil {
panic("featurefmt: could not register a nil Lister")
}

listersM.Lock()
defer listersM.Unlock()

if _, dup := listers[name]; dup {
panic("featurefmt: RegisterLister called twice for " + name)
}

listers[name] = l
}

// ListFeatures produces the list of FeatureVersions in an image layer using
// every registered Lister.
func ListFeatures(files tarutil.FilesMap) ([]database.FeatureVersion, error) {
listersM.RLock()
defer listersM.RUnlock()

var totalFeatures []database.FeatureVersion
for _, lister := range listers {
features, err := lister.ListFeatures(files)
if err != nil {
return []database.FeatureVersion{}, err
}
totalFeatures = append(totalFeatures, features...)
}

return totalFeatures, nil
}

// RequiredFilenames returns the total list of files required for all
// registered Listers.
func RequiredFilenames() (files []string) {
listersM.RLock()
defer listersM.RUnlock()

for _, lister := range listers {
files = append(files, lister.RequiredFilenames()...)
}

return
}

// TestData represents the data used to test an implementation of Lister.
type TestData struct {
Files tarutil.FilesMap
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
}

// TestLister runs a Lister on each provided instance of TestData and asserts
// the ouput to be equal to the expected output.
func TestLister(t *testing.T, l Lister, testData []TestData) {
for _, td := range testData {
featureVersions, err := l.ListFeatures(td.Files)
if assert.Nil(t, err) && assert.Len(t, featureVersions, len(td.FeatureVersions)) {
for _, expectedFeatureVersion := range td.FeatureVersions {
assert.Contains(t, featureVersions, expectedFeatureVersion)
}
}
}
}
21 changes: 9 additions & 12 deletions worker/detectors/feature/rpm/rpm.go → ext/featurefmt/rpm/rpm.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// Package rpm implements a featurefmt.Lister for rpm packages.
package rpm

import (
Expand All @@ -23,26 +24,24 @@ import (
"github.com/coreos/pkg/capnslog"

"github.com/coreos/clair/database"
"github.com/coreos/clair/ext/featurefmt"
"github.com/coreos/clair/ext/versionfmt"
"github.com/coreos/clair/ext/versionfmt/rpm"
"github.com/coreos/clair/pkg/commonerr"
"github.com/coreos/clair/pkg/tarutil"
"github.com/coreos/clair/utils"
"github.com/coreos/clair/worker/detectors"
)

var log = capnslog.NewPackageLogger("github.com/coreos/clair", "rpm")
var log = capnslog.NewPackageLogger("github.com/coreos/clair", "ext/featurefmt/rpm")

// RpmFeaturesDetector implements FeaturesDetector and detects rpm packages
// It requires the "rpm" binary to be in the PATH
type RpmFeaturesDetector struct{}
type lister struct{}

func init() {
detectors.RegisterFeaturesDetector("rpm", &RpmFeaturesDetector{})
featurefmt.RegisterLister("rpm", &lister{})
}

// Detect detects packages using var/lib/rpm/Packages from the input data
func (detector *RpmFeaturesDetector) Detect(data map[string][]byte) ([]database.FeatureVersion, error) {
f, hasFile := data["var/lib/rpm/Packages"]
func (l lister) ListFeatures(files tarutil.FilesMap) ([]database.FeatureVersion, error) {
f, hasFile := files["var/lib/rpm/Packages"]
if !hasFile {
return []database.FeatureVersion{}, nil
}
Expand Down Expand Up @@ -116,8 +115,6 @@ func (detector *RpmFeaturesDetector) Detect(data map[string][]byte) ([]database.
return packages, nil
}

// GetRequiredFiles returns the list of files required for Detect, without
// leading /
func (detector *RpmFeaturesDetector) GetRequiredFiles() []string {
func (l lister) RequiredFilenames() []string {
return []string{"var/lib/rpm/Packages"}
}

0 comments on commit cda3d48

Please sign in to comment.