Improve structure

Signed-off-by: Christian Dupuis <[email protected]>

Author: cdupuis

commands/cmd.go

@@ -222,7 +222,7 @@ func NewRootCmd(name string, isPlugin bool, dockerCli command.Cli) *cobra.Comman
 
 			if len(*cves) > 0 {
 				for _, c := range *cves {
-					query.FormatCve(sb, &c)
+					types.FormatCve(sb, &c)
 
 					if !remediate {
 						continue
@@ -239,7 +239,7 @@ func NewRootCmd(name string, isPlugin bool, dockerCli command.Cli) *cobra.Comman
 								}
 							}
 
-							if rem := query.FormatPackageRemediation(p, c); rem != "" {
+							if rem := types.FormatPackageRemediation(p, c); rem != "" {
 								remediation = append(remediation, rem)
 							}
 						}
@@ -250,14 +250,14 @@ func NewRootCmd(name string, isPlugin bool, dockerCli command.Cli) *cobra.Comman
 					defer s.Stop()
 					baseImages, index, _ := query.Detect(img, true, workspace, apiKey)
 					s.Stop()
-					var baseImage *query.Image
+					var baseImage *types.Image
 					if layerIndex <= index && baseImages != nil && len(*baseImages) > 0 {
 						baseImage = &(*baseImages)[0]
 
 						fmt.Println("")
 						fmt.Println("installed in base image")
 						fmt.Println("")
-						fmt.Println(query.FormatImage(baseImage))
+						fmt.Println(types.FormatImage(baseImage))
 					}
 
 					if baseImage != nil {
@@ -268,13 +268,13 @@ func NewRootCmd(name string, isPlugin bool, dockerCli command.Cli) *cobra.Comman
 						if aBaseImage != nil && len(*aBaseImage) > 0 {
 							e := []string{fmt.Sprintf("Update base image\n\nAlternative base images not vulnerable to %s", c.SourceId)}
 							for _, a := range *aBaseImage {
-								e = append(e, query.FormatImage(&a))
+								e = append(e, types.FormatImage(&a))
 							}
 							remediation = append(remediation, strings.Join(e, "\n\n"))
 						}
 					}
 
-					query.FormatRemediation(remediation)
+					types.FormatRemediation(remediation)
 				}
 
 				os.Exit(1)

query/base.go

@@ -23,96 +23,24 @@ import (
 	"io"
 	"net/http"
 	"sort"
-	"time"
 
+	"github.com/docker/index-cli-plugin/types"
 	v1 "github.com/google/go-containerregistry/pkg/v1"
 	"github.com/opencontainers/go-digest"
 	"github.com/opencontainers/image-spec/identity"
 	"github.com/pkg/errors"
 	"olympos.io/encoding/edn"
 )
 
-type IndexImage struct {
-	Digest    string    `json:"digest"`
-	CreatedAt time.Time `json:"createdAt"`
-	Platform  struct {
-		Os      string `json:"os"`
-		Arch    string `json:"arch"`
-		Variant string `json:"variant"`
-	} `json:"platform"`
-	Layers []struct {
-		Digest       string    `json:"digest"`
-		Size         int       `json:"size"`
-		LastModified time.Time `json:"lastModified"`
-	} `json:"layers"`
-	DigestChainId string `json:"digestChainId"`
-	DiffIdChainId string `json:"diffIdChainId"`
-}
-
-type IndexManifestList struct {
-	Name   string       `json:"name"`
-	Tags   []string     `json:"tags"`
-	Digest string       `json:"digest"`
-	Images []IndexImage `json:"images"`
-}
-
-type ManifestList struct {
-	Digest string `edn:"docker.manifest-list/digest"`
-	Tags   []struct {
-		Name string `edn:"docker.tag/name"`
-	} `edn:"docker.manifest-list/tag"`
-}
-
-type Report struct {
-	Total       int64 `edn:"vulnerability.report/total"`
-	Critical    int64 `edn:"vulnerability.report/critical"`
-	High        int64 `edn:"vulnerability.report/high"`
-	Medium      int64 `edn:"vulnerability.report/medium"`
-	Low         int64 `edn:"vulnerability.report/low"`
-	Unspecified int64 `edn:"vulnerability.report/unspecified"`
-}
-
-type Repository struct {
-	Badge         string   `edn:"docker.repository/badge"`
-	Host          string   `edn:"docker.repository/host"`
-	Name          string   `edn:"docker.repository/name"`
-	SupportedTags []string `edn:"docker.repository/supported-tags"`
-}
-
-type Image struct {
-	TeamId    string    `edn:"atomist/team-id"`
-	Digest    string    `edn:"docker.image/digest"`
-	CreatedAt time.Time `edn:"docker.image/created-at"`
-	Tags      []string  `edn:"docker.image/tags"`
-	Tag       []struct {
-		Name string `edn:"docker.tag/name"`
-	} `edn:"docker.image/tag"`
-	ManifestList []ManifestList `edn:"docker.image/manifest-list"`
-	Repository   Repository     `edn:"docker.image/repository"`
-	File         struct {
-		Path string `edn:"git.file/path"`
-	} `edn:"docker.image/file"`
-	Commit struct {
-		Sha  string `edn:"git.commit/sha"`
-		Repo struct {
-			Name string `edn:"git.repo/name"`
-			Org  struct {
-				Name string `edn:"git.org/name"`
-			} `edn:"git.repo/org"`
-		} `edn:"git.commit/repo"`
-	} `edn:"docker.image/commit"`
-	Report []Report `edn:"vulnerability.report/report"`
-}
-
 type ImageQueryResult struct {
 	Query struct {
-		Data [][]Image `edn:"data"`
+		Data [][]types.Image `edn:"data"`
 	} `edn:"query"`
 }
 
 type RepositoryQueryResult struct {
 	Query struct {
-		Data [][]Repository `edn:"data"`
+		Data [][]types.Repository `edn:"data"`
 	} `edn:"query"`
 }
 
@@ -125,7 +53,7 @@ var baseImageCveQuery string
 //go:embed repository_query.edn
 var repositoryQuery string
 
-func Detect(img *v1.Image, excludeSelf bool, workspace string, apiKey string) (*[]Image, int, error) {
+func Detect(img *v1.Image, excludeSelf bool, workspace string, apiKey string) (*[]types.Image, int, error) {
 	digests := make([]digest.Digest, 0)
 	layers, _ := (*img).Layers()
 	for _, layer := range layers {
@@ -138,7 +66,7 @@ func Detect(img *v1.Image, excludeSelf bool, workspace string, apiKey string) (*
 	}
 
 	chainIds := make([]digest.Digest, 0)
-	var images *[]Image
+	var images *[]types.Image
 	var index int
 	for i := range digests {
 		chainIds = append(chainIds, digests[i])
@@ -158,7 +86,7 @@ func Detect(img *v1.Image, excludeSelf bool, workspace string, apiKey string) (*
 	return images, index, nil
 }
 
-func ForBaseImageInIndex(digest digest.Digest, workspace string, apiKey string) (*[]Image, error) {
+func ForBaseImageInIndex(digest digest.Digest, workspace string, apiKey string) (*[]types.Image, error) {
 	url := fmt.Sprintf("https://api.dso.docker.com/docker-images/chain-ids/%s.json", digest.String())
 
 	resp, err := http.Get(url)
@@ -167,7 +95,7 @@ func ForBaseImageInIndex(digest digest.Digest, workspace string, apiKey string)
 	}
 
 	if resp.StatusCode == 200 {
-		var manifestList []IndexManifestList
+		var manifestList []types.IndexManifestList
 		body, err := io.ReadAll(resp.Body)
 		if err != nil {
 			return nil, errors.Wrapf(err, "failed to read response body")
@@ -176,7 +104,7 @@ func ForBaseImageInIndex(digest digest.Digest, workspace string, apiKey string)
 		if err != nil {
 			return nil, errors.Wrapf(err, "failed to unmarshal response body")
 		}
-		var ii IndexImage
+		var ii types.IndexImage
 		for _, i := range manifestList[0].Images {
 			if i.DigestChainId == digest.String() || i.DiffIdChainId == digest.String() {
 				ii = i
@@ -187,22 +115,22 @@ func ForBaseImageInIndex(digest digest.Digest, workspace string, apiKey string)
 		if err != nil {
 			return nil, errors.Wrapf(err, "failed to query for respository")
 		}
-		image := Image{
+		image := types.Image{
 			Digest:     ii.Digest,
 			CreatedAt:  ii.CreatedAt,
 			Tags:       manifestList[0].Tags,
 			Repository: *repository,
-			Report: []Report{{
+			Report: []types.Report{{
 				Total: -1,
 			}},
 		}
-		return &[]Image{image}, nil
+		return &[]types.Image{image}, nil
 	}
 
 	return nil, nil
 }
 
-func ForBaseImageWithoutCve(cve string, name string, img *v1.Image, workspace string, apiKey string) (*[]Image, error) {
+func ForBaseImageWithoutCve(cve string, name string, img *v1.Image, workspace string, apiKey string) (*[]types.Image, error) {
 	cf, _ := (*img).ConfigFile()
 	resp, err := query(fmt.Sprintf(baseImageCveQuery, cve, name, cf.OS, cf.Architecture, cf.Variant), "base_image_cve_query", workspace, apiKey)
 
@@ -212,7 +140,7 @@ func ForBaseImageWithoutCve(cve string, name string, img *v1.Image, workspace st
 		return nil, errors.Wrapf(err, "failed to unmarshal response")
 	}
 	if len(result.Query.Data) > 0 {
-		images := make([]Image, 0)
+		images := make([]types.Image, 0)
 
 		for _, img := range result.Query.Data {
 			tba := true
@@ -228,8 +156,8 @@ func ForBaseImageWithoutCve(cve string, name string, img *v1.Image, workspace st
 			}
 		}
 		sort.Slice(images, func(i, j int) bool {
-			itag := Tags(&images[i])[0]
-			jtag := Tags(&images[j])[0]
+			itag := types.Tags(&images[i])[0]
+			jtag := types.Tags(&images[j])[0]
 			both := []string{itag, jtag}
 			sort.Strings(both)
 			return both[0] == itag
@@ -241,7 +169,7 @@ func ForBaseImageWithoutCve(cve string, name string, img *v1.Image, workspace st
 }
 
 // ForBaseImageInDb returns images with matching digest in :docker.image/blob-digest or :docker.image/diff-chain-id
-func ForBaseImageInDb(digest digest.Digest, workspace string, apiKey string) (*[]Image, error) {
+func ForBaseImageInDb(digest digest.Digest, workspace string, apiKey string) (*[]types.Image, error) {
 	resp, err := query(fmt.Sprintf(baseImageQuery, digest), "base_image_query", workspace, apiKey)
 
 	var result ImageQueryResult
@@ -250,7 +178,7 @@ func ForBaseImageInDb(digest digest.Digest, workspace string, apiKey string) (*[
 		return nil, errors.Wrapf(err, "failed to unmarshal response")
 	}
 	if len(result.Query.Data) > 0 {
-		images := make([]Image, 0)
+		images := make([]types.Image, 0)
 
 		for _, img := range result.Query.Data {
 			tba := true
@@ -271,7 +199,7 @@ func ForBaseImageInDb(digest digest.Digest, workspace string, apiKey string) (*[
 	}
 }
 
-func ForRepositoryInDb(repo string, workspace string, apiKey string) (*Repository, error) {
+func ForRepositoryInDb(repo string, workspace string, apiKey string) (*types.Repository, error) {
 	resp, err := query(fmt.Sprintf(repositoryQuery, repo), "repository_query", workspace, apiKey)
 
 	var result RepositoryQueryResult

registry/read.go

@@ -17,17 +17,27 @@
 package registry
 
 import (
-	v1 "github.com/google/go-containerregistry/pkg/v1"
+	"github.com/atomist-skills/go-skill"
 	"github.com/google/go-containerregistry/pkg/v1/layout"
 	"github.com/pkg/errors"
 )
 
-func ReadImage(path string) (v1.Image, error) {
+func ReadImage(name string, path string) (*ImageCache, error) {
+	skill.Log.Infof("Loading image from %s", path)
 	index, err := layout.ImageIndexFromPath(path)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to read manifest index at %s", path)
 	}
 	mani, err := index.IndexManifest()
 	hash := mani.Manifests[0].Digest
-	return index.Image(hash)
+	img, _ := index.Image(hash)
+	skill.Log.Infof("Loaded image")
+	return &ImageCache{
+		Name:      name,
+		Path:      path,
+		Image:     &img,
+		ImagePath: path,
+		Ref:       nil,
+		copy:      false,
+	}, nil
 }