Your advanced code editor is loading.

Please wait a moment.

#editor-loading { display: none; }

// Copyright 2022, 2023 Chainguard, Inc. // // 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 build_test

import ( “context” “net/http” “net/http/httptest” “path/filepath” “strings” “testing”

"github.com/stretchr/testify/require"

"chainguard.dev/apko/pkg/apk/auth" "chainguard.dev/apko/pkg/apk/fs" "chainguard.dev/apko/pkg/build" "chainguard.dev/apko/pkg/build/types"

)

func TestBuildLayer(t *testing.T) { }

func TestBuildImage(t *testing.T) { ctx := context.Background()

opts := []build.Option{
          build.WithConfig("apko.yaml", []string{"testdata"}),
          }
          
          bc, err := build.New(ctx, fs.NewMemFS(), opts...)
          if err != nil {
          t.Fatal(err)
          }
          if err := bc.BuildImage(ctx); err != nil {
          t.Fatal(err)
          }
          installed, err := bc.InstalledPackages()
          if err != nil {
          t.Fatal(err)
          }
          require.Len(t, installed, 2)
          require.Equal(t, installed[0].Name, "pretend-baselayout")
          require.Equal(t, installed[0].Version, "1.0.0-r0")
          require.Equal(t, installed[1].Name, "replayout")
          require.Equal(t, installed[1].Version, "1.0.0-r0")

}

func TestBuildImageFromLockFile(t *testing.T) { ctx := context.Background()

opts := []build.Option{
          build.WithConfig(filepath.Join("testdata", "apko.yaml"), []string{}),
          build.WithLockFile(filepath.Join("testdata", "apko.lock.json")),
          }
          
          bc, err := build.New(ctx, fs.NewMemFS(), opts...)
          if err != nil {
          t.Fatal(err)
          }
          if err := bc.BuildImage(ctx); err != nil {
          t.Fatal(err)
          }
          installed, err := bc.InstalledPackages()
          if err != nil {
          t.Fatal(err)
          }
          require.Len(t, installed, 2)
          require.Equal(t, installed[0].Name, "pretend-baselayout")
          require.Equal(t, installed[0].Version, "1.0.0-r0")
          require.Equal(t, installed[1].Name, "replayout")
          require.Equal(t, installed[1].Version, "1.0.0-r0")

}

func TestBuildImageFromTooOldResolvedFile(t *testing.T) { ctx := context.Background()

opts := []build.Option{
          build.WithConfig(filepath.Join("testdata", "apko.yaml"), []string{}),
          build.WithLockFile(filepath.Join("testdata", "apko.pre-0.13.lock.json")),
          }
          
          bc, err := build.New(ctx, fs.NewMemFS(), opts...)
          if err != nil {
          t.Fatal(err)
          }
          err = bc.BuildImage(ctx)
          require.Equal(t, "failed getting packages for install from lockfile testdata/apko.pre-0.13.lock.json: "+
          "locked package pretend-baselayout has missing checksum (please regenerate the lock file with Apko >=0.13)",
          err.Error())

}

func TestAuth_good(t *testing.T) { called := false testUser, testPass := “user”, “pass” s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { w.Header().Set(“ETag”, “234”) if r.Method == http.MethodHead { return }

    called = true
          if gotuser, gotpass, ok := r.BasicAuth(); !ok || gotuser != testUser || gotpass != testPass {
          t.Logf("got user: %q, pass: %q", gotuser, gotpass)
          w.WriteHeader(http.StatusForbidden)
          return
          }
          http.FileServer(http.Dir("testdata/packages")).ServeHTTP(w, r)
          }))
          defer s.Close()
          host := strings.TrimPrefix(s.URL, "http://")
          
          ctx := context.Background()
          bc, err := build.New(ctx, fs.NewMemFS(),
          build.WithImageConfiguration(types.ImageConfiguration{
          Contents: types.ImageContents{
          RuntimeRepositories: []string{s.URL},
          Keyring:             []string{s.URL + "/melange.rsa.pub"},
          Packages:            []string{"pretend-baselayout"},
          },
          Archs: types.ParseArchitectures([]string{"amd64", "arm64"}),
          }),
          build.WithAuthenticator(auth.StaticAuth(host, testUser, testPass)))
          if err != nil {
          t.Fatal(err)
          }
          err = bc.BuildImage(ctx)
          require.NoError(t, err, "build image failed")
          require.True(t, called)

}

func TestAuth_bad(t *testing.T) { called := false testUser, testPass := “user”, “pass” s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { w.Header().Set(“ETag”, “345”) if r.Method == http.MethodHead { return }

    called = true
          if gotuser, gotpass, ok := r.BasicAuth(); !ok || gotuser != testUser || gotpass != testPass {
          w.WriteHeader(http.StatusForbidden)
          return
          }
          http.FileServer(http.Dir("testdata/packages")).ServeHTTP(w, r)
          }))
          defer s.Close()
          host := strings.TrimPrefix(s.URL, "http://")
          
          ctx := context.Background()
          _, err := build.New(ctx, fs.NewMemFS(),
          build.WithImageConfiguration(types.ImageConfiguration{
          Contents: types.ImageContents{
          Keyring: []string{s.URL + "/melange.rsa.pub"},
          // We don't even need to specify repository or packages, since keyring init will fail without auth.
          },
          Archs: types.ParseArchitectures([]string{"amd64", "arm64"}),
          }),
          build.WithAuthenticator(auth.StaticAuth(host, "baduser", "badpass")),
          )
          require.Error(t, err, "build should have failed to init keyring")
          require.True(t, called)

}

Explanation

This code tests the BuildImage function of the apko package.

Test Scenarios:

TestBuildImage:
It creates a new build context with the default configuration file (apko.yaml) in the testdata directory.
It builds the image using bc.BuildImage(ctx).
It checks the installed packages by calling bc.InstalledPackages().
It asserts that the installed packages are pretend-baselayout (version 1.0.0-r0) and replayout (version 1.0.0-r0).
TestBuildImageFromLockFile:
It creates a new build context with both the configuration file (apko.yaml) and the lock file (apko.lock.json) in the testdata directory.
It builds the image.
It verifies that the installed packages are the same as in the previous test case.
This test demonstrates the ability to build the image based on the locked package dependencies.
TestBuildImageFromTooOldResolvedFile:
It creates a new build context with the configuration file and a lock file (apko.pre-0.13.lock.json) that is incompatible with the current apko version.
It attempts to build the image.
The test expects an error message indicating that the lock file is too old and needs to be regenerated with a newer apko version.
This ensures that apko gracefully handles outdated lock files.

Key Points:

The BuildImage function is the core functionality of the package, which is responsible for building the image based on the configuration provided.
build.WithConfig and build.WithLockFile are options for customizing the build process by specifying configuration and lock file paths.
The test cases thoroughly cover the BuildImage function, including scenarios with and without a lock file, and with an outdated lock file.
The InstalledPackages() method is used to check the installed packages after building the image.

This code is a good example of unit testing for a package that involves building container images. It covers various use cases and verifies the expected behavior, providing confidence in the functionality of apko.

Your advanced code editor is loading.

Please wait a moment.

Explanation

Graph

Symbols

We couldn't identify any entrypoints. If you believe this to be incorrect then please contact support.