From 19c9af6869a302d4b07a4d3a5ee23530818733ac Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Virtus?= <tomas.virtus@canonical.com>
Date: Fri, 16 Jun 2023 07:32:31 +0200
Subject: [PATCH] archive: Add Info() method

At some point we will need to get information about (deb) packages from
(Go) packages other than archive, namely from the slicer package.
For instance:
- Package entries in Chisel DB will include version, digest and
  architecture.
- Multi-archive package selection will need to know versions of a
  package in all configured archives.

Add Info() method to the Archive interface that returns a new
PackageInfo interface that contains accessors for the underlying
control.Section of the package. Currently these accessors are Name(),
Version(), Arch() and SHA256() methods.

The reason to introduce PackageInfo interface instead of returing
control.Section directly is keep the archive abstraction and not leak
implementation details.
---
 internal/archive/archive.go      | 24 +++++++++++++++++++++++
 internal/archive/archive_test.go | 33 ++++++++++++++++++++++++++++++++
 internal/slicer/slicer_test.go   | 29 ++++++++++++++++++++++++++++
 3 files changed, 86 insertions(+)

diff --git a/internal/archive/archive.go b/internal/archive/archive.go
index 63badc8f..56a3fcd9 100644
--- a/internal/archive/archive.go
+++ b/internal/archive/archive.go
@@ -13,9 +13,17 @@ import (
 	"github.com/canonical/chisel/internal/deb"
 )
 
+type PackageInfo interface {
+	Name() string
+	Version() string
+	Arch() string
+	SHA256() string
+}
+
 type Archive interface {
 	Options() *Options
 	Fetch(pkg string) (io.ReadCloser, error)
+	Info(pkg string) PackageInfo
 	Exists(pkg string) bool
 }
 
@@ -86,6 +94,22 @@ func (a *ubuntuArchive) Exists(pkg string) bool {
 	return err == nil
 }
 
+type pkgInfo struct{ control.Section }
+
+var _ PackageInfo = pkgInfo{}
+
+func (info pkgInfo) Name() string    { return info.Get("Package") }
+func (info pkgInfo) Version() string { return info.Get("Version") }
+func (info pkgInfo) Arch() string    { return info.Get("Architecture") }
+func (info pkgInfo) SHA256() string  { return info.Get("SHA256") }
+
+func (a *ubuntuArchive) Info(pkg string) PackageInfo {
+	if section, _, _ := a.selectPackage(pkg); section != nil {
+		return &pkgInfo{section}
+	}
+	return nil
+}
+
 func (a *ubuntuArchive) selectPackage(pkg string) (control.Section, *ubuntuIndex, error) {
 	var selectedVersion string
 	var selectedSection control.Section
diff --git a/internal/archive/archive_test.go b/internal/archive/archive_test.go
index cb9f3278..b18fc60c 100644
--- a/internal/archive/archive_test.go
+++ b/internal/archive/archive_test.go
@@ -332,6 +332,39 @@ func (s *httpSuite) TestArchiveLabels(c *C) {
 	c.Assert(err, ErrorMatches, `.*\bno Ubuntu section`)
 }
 
+func (s *httpSuite) TestPackageInfo(c *C) {
+	s.prepareArchive("jammy", "22.04", "amd64", []string{"main", "universe"})
+
+	options := archive.Options{
+		Label:      "ubuntu",
+		Version:    "22.04",
+		Arch:       "amd64",
+		Suites:     []string{"jammy"},
+		Components: []string{"main", "universe"},
+		CacheDir:   c.MkDir(),
+	}
+
+	archive, err := archive.Open(&options)
+	c.Assert(err, IsNil)
+
+	info1 := archive.Info("mypkg1")
+	c.Assert(info1, NotNil)
+	c.Assert(info1.Name(), Equals, "mypkg1")
+	c.Assert(info1.Version(), Equals, "1.1")
+	c.Assert(info1.Arch(), Equals, "amd64")
+	c.Assert(info1.SHA256(), Equals, "1f08ef04cfe7a8087ee38a1ea35fa1810246648136c3c42d5a61ad6503d85e05")
+
+	info3 := archive.Info("mypkg3")
+	c.Assert(info3, NotNil)
+	c.Assert(info3.Name(), Equals, "mypkg3")
+	c.Assert(info3.Version(), Equals, "1.3")
+	c.Assert(info3.Arch(), Equals, "amd64")
+	c.Assert(info3.SHA256(), Equals, "fe377bf13ba1a5cb287cb4e037e6e7321281c929405ae39a72358ef0f5d179aa")
+
+	info99 := archive.Info("mypkg99")
+	c.Assert(info99, IsNil)
+}
+
 func read(r io.Reader) string {
 	data, err := io.ReadAll(r)
 	if err != nil {
diff --git a/internal/slicer/slicer_test.go b/internal/slicer/slicer_test.go
index 471d64a1..cdb68f12 100644
--- a/internal/slicer/slicer_test.go
+++ b/internal/slicer/slicer_test.go
@@ -23,6 +23,7 @@ var (
 )
 
 type testPackage struct {
+	info    map[string]string
 	content []byte
 }
 
@@ -607,6 +608,22 @@ const defaultChiselYaml = `
 			components: [main, universe]
 `
 
+type testPackageInfo map[string]string
+
+var _ archive.PackageInfo = (testPackageInfo)(nil)
+
+func (info testPackageInfo) Name() string    { return info["Package"] }
+func (info testPackageInfo) Version() string { return info["Version"] }
+func (info testPackageInfo) Arch() string    { return info["Architecture"] }
+func (info testPackageInfo) SHA256() string  { return info["SHA256"] }
+
+func (s testPackageInfo) Get(key string) (value string) {
+	if s != nil {
+		value = s[key]
+	}
+	return
+}
+
 type testArchive struct {
 	options archive.Options
 	pkgs    map[string]testPackage
@@ -628,6 +645,18 @@ func (a *testArchive) Exists(pkg string) bool {
 	return ok
 }
 
+func (a *testArchive) Info(pkg string) archive.PackageInfo {
+	var info map[string]string
+	if pkgData, ok := a.pkgs[pkg]; ok {
+		if info = pkgData.info; info == nil {
+			info = map[string]string{
+				"Version": "1.0",
+			}
+		}
+	}
+	return testPackageInfo(info)
+}
+
 func (s *S) TestRun(c *C) {
 	for _, test := range slicerTests {
 		c.Logf("Summary: %s", test.summary)