mirror of https://github.com/helm/helm
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
295 lines
9.4 KiB
295 lines
9.4 KiB
/*
|
|
Copyright The Helm 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 registry
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/url"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/containerd/containerd/errdefs"
|
|
"github.com/distribution/distribution/v3/configuration"
|
|
"github.com/distribution/distribution/v3/registry"
|
|
_ "github.com/distribution/distribution/v3/registry/auth/htpasswd"
|
|
_ "github.com/distribution/distribution/v3/registry/storage/driver/inmemory"
|
|
"github.com/phayes/freeport"
|
|
"github.com/stretchr/testify/suite"
|
|
"golang.org/x/crypto/bcrypt"
|
|
auth "oras.land/oras-go/pkg/auth/docker"
|
|
|
|
"helm.sh/helm/v3/pkg/chart"
|
|
)
|
|
|
|
var (
|
|
testCacheRootDir = "helm-registry-test"
|
|
testHtpasswdFileBasename = "authtest.htpasswd"
|
|
testUsername = "myuser"
|
|
testPassword = "mypass"
|
|
)
|
|
|
|
type RegistryClientTestSuite struct {
|
|
suite.Suite
|
|
Out io.Writer
|
|
DockerRegistryHost string
|
|
CompromisedRegistryHost string
|
|
CacheRootDir string
|
|
RegistryClient *Client
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) SetupSuite() {
|
|
suite.CacheRootDir = testCacheRootDir
|
|
os.RemoveAll(suite.CacheRootDir)
|
|
os.Mkdir(suite.CacheRootDir, 0700)
|
|
|
|
var out bytes.Buffer
|
|
suite.Out = &out
|
|
credentialsFile := filepath.Join(suite.CacheRootDir, CredentialsFileBasename)
|
|
|
|
client, err := auth.NewClient(credentialsFile)
|
|
suite.Nil(err, "no error creating auth client")
|
|
|
|
resolver, err := client.Resolver(context.Background(), http.DefaultClient, false)
|
|
suite.Nil(err, "no error creating resolver")
|
|
|
|
// create cache
|
|
cache, err := NewCache(
|
|
CacheOptDebug(true),
|
|
CacheOptWriter(suite.Out),
|
|
CacheOptRoot(filepath.Join(suite.CacheRootDir, CacheRootDir)),
|
|
)
|
|
suite.Nil(err, "no error creating cache")
|
|
|
|
// init test client
|
|
suite.RegistryClient, err = NewClient(
|
|
ClientOptDebug(true),
|
|
ClientOptWriter(suite.Out),
|
|
ClientOptAuthorizer(&Authorizer{
|
|
Client: client,
|
|
}),
|
|
ClientOptResolver(&Resolver{
|
|
Resolver: resolver,
|
|
}),
|
|
ClientOptCache(cache),
|
|
)
|
|
suite.Nil(err, "no error creating registry client")
|
|
|
|
// create htpasswd file (w BCrypt, which is required)
|
|
pwBytes, err := bcrypt.GenerateFromPassword([]byte(testPassword), bcrypt.DefaultCost)
|
|
suite.Nil(err, "no error generating bcrypt password for test htpasswd file")
|
|
htpasswdPath := filepath.Join(suite.CacheRootDir, testHtpasswdFileBasename)
|
|
err = ioutil.WriteFile(htpasswdPath, []byte(fmt.Sprintf("%s:%s\n", testUsername, string(pwBytes))), 0644)
|
|
suite.Nil(err, "no error creating test htpasswd file")
|
|
|
|
// Registry config
|
|
config := &configuration.Configuration{}
|
|
port, err := freeport.GetFreePort()
|
|
suite.Nil(err, "no error finding free port for test registry")
|
|
suite.DockerRegistryHost = fmt.Sprintf("localhost:%d", port)
|
|
config.HTTP.Addr = fmt.Sprintf(":%d", port)
|
|
config.HTTP.DrainTimeout = time.Duration(10) * time.Second
|
|
config.Storage = map[string]configuration.Parameters{"inmemory": map[string]interface{}{}}
|
|
config.Auth = configuration.Auth{
|
|
"htpasswd": configuration.Parameters{
|
|
"realm": "localhost",
|
|
"path": htpasswdPath,
|
|
},
|
|
}
|
|
dockerRegistry, err := registry.NewRegistry(context.Background(), config)
|
|
suite.Nil(err, "no error creating test registry")
|
|
|
|
suite.CompromisedRegistryHost = initCompromisedRegistryTestServer()
|
|
|
|
// Start Docker registry
|
|
go dockerRegistry.ListenAndServe()
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) TearDownSuite() {
|
|
os.RemoveAll(suite.CacheRootDir)
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) Test_0_Login() {
|
|
err := suite.RegistryClient.Login(suite.DockerRegistryHost, "badverybad", "ohsobad", false)
|
|
suite.NotNil(err, "error logging into registry with bad credentials")
|
|
|
|
err = suite.RegistryClient.Login(suite.DockerRegistryHost, "badverybad", "ohsobad", true)
|
|
suite.NotNil(err, "error logging into registry with bad credentials, insecure mode")
|
|
|
|
err = suite.RegistryClient.Login(suite.DockerRegistryHost, testUsername, testPassword, false)
|
|
suite.Nil(err, "no error logging into registry with good credentials")
|
|
|
|
err = suite.RegistryClient.Login(suite.DockerRegistryHost, testUsername, testPassword, true)
|
|
suite.Nil(err, "no error logging into registry with good credentials, insecure mode")
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) Test_1_SaveChart() {
|
|
ref, err := ParseReference(fmt.Sprintf("%s/testrepo/testchart:1.2.3", suite.DockerRegistryHost))
|
|
suite.Nil(err)
|
|
|
|
// empty chart
|
|
err = suite.RegistryClient.SaveChart(&chart.Chart{}, ref)
|
|
suite.NotNil(err)
|
|
|
|
// valid chart
|
|
ch := &chart.Chart{}
|
|
ch.Metadata = &chart.Metadata{
|
|
APIVersion: "v1",
|
|
Name: "testchart",
|
|
Version: "1.2.3",
|
|
}
|
|
err = suite.RegistryClient.SaveChart(ch, ref)
|
|
suite.Nil(err)
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) Test_2_LoadChart() {
|
|
|
|
// non-existent ref
|
|
ref, err := ParseReference(fmt.Sprintf("%s/testrepo/whodis:9.9.9", suite.DockerRegistryHost))
|
|
suite.Nil(err)
|
|
_, err = suite.RegistryClient.LoadChart(ref)
|
|
suite.NotNil(err)
|
|
|
|
// existing ref
|
|
ref, err = ParseReference(fmt.Sprintf("%s/testrepo/testchart:1.2.3", suite.DockerRegistryHost))
|
|
suite.Nil(err)
|
|
ch, err := suite.RegistryClient.LoadChart(ref)
|
|
suite.Nil(err)
|
|
suite.Equal("testchart", ch.Metadata.Name)
|
|
suite.Equal("1.2.3", ch.Metadata.Version)
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) Test_3_PushChart() {
|
|
|
|
// non-existent ref
|
|
ref, err := ParseReference(fmt.Sprintf("%s/testrepo/whodis:9.9.9", suite.DockerRegistryHost))
|
|
suite.Nil(err)
|
|
err = suite.RegistryClient.PushChart(ref)
|
|
suite.NotNil(err)
|
|
|
|
// existing ref
|
|
ref, err = ParseReference(fmt.Sprintf("%s/testrepo/testchart:1.2.3", suite.DockerRegistryHost))
|
|
suite.Nil(err)
|
|
err = suite.RegistryClient.PushChart(ref)
|
|
suite.Nil(err)
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) Test_4_PullChart() {
|
|
|
|
// non-existent ref
|
|
ref, err := ParseReference(fmt.Sprintf("%s/testrepo/whodis:9.9.9", suite.DockerRegistryHost))
|
|
suite.Nil(err)
|
|
_, err = suite.RegistryClient.PullChart(ref)
|
|
suite.NotNil(err)
|
|
|
|
// existing ref
|
|
ref, err = ParseReference(fmt.Sprintf("%s/testrepo/testchart:1.2.3", suite.DockerRegistryHost))
|
|
suite.Nil(err)
|
|
_, err = suite.RegistryClient.PullChart(ref)
|
|
suite.Nil(err)
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) Test_5_PrintChartTable() {
|
|
err := suite.RegistryClient.PrintChartTable()
|
|
suite.Nil(err)
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) Test_6_RemoveChart() {
|
|
|
|
// non-existent ref
|
|
ref, err := ParseReference(fmt.Sprintf("%s/testrepo/whodis:9.9.9", suite.DockerRegistryHost))
|
|
suite.Nil(err)
|
|
err = suite.RegistryClient.RemoveChart(ref)
|
|
suite.NotNil(err)
|
|
|
|
// existing ref
|
|
ref, err = ParseReference(fmt.Sprintf("%s/testrepo/testchart:1.2.3", suite.DockerRegistryHost))
|
|
suite.Nil(err)
|
|
err = suite.RegistryClient.RemoveChart(ref)
|
|
suite.Nil(err)
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) Test_7_Logout() {
|
|
err := suite.RegistryClient.Logout("this-host-aint-real:5000")
|
|
suite.NotNil(err, "error logging out of registry that has no entry")
|
|
|
|
err = suite.RegistryClient.Logout(suite.DockerRegistryHost)
|
|
suite.Nil(err, "no error logging out of registry")
|
|
}
|
|
|
|
func (suite *RegistryClientTestSuite) Test_8_ManInTheMiddle() {
|
|
ref, err := ParseReference(fmt.Sprintf("%s/testrepo/supposedlysafechart:9.9.9", suite.CompromisedRegistryHost))
|
|
suite.Nil(err)
|
|
|
|
// returns content that does not match the expected digest
|
|
_, err = suite.RegistryClient.PullChart(ref)
|
|
suite.NotNil(err)
|
|
suite.True(errdefs.IsFailedPrecondition(err))
|
|
}
|
|
|
|
func TestRegistryClientTestSuite(t *testing.T) {
|
|
suite.Run(t, new(RegistryClientTestSuite))
|
|
}
|
|
|
|
func initCompromisedRegistryTestServer() string {
|
|
s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
if strings.Contains(r.URL.Path, "manifests") {
|
|
w.Header().Set("Content-Type", "application/vnd.oci.image.manifest.v1+json")
|
|
w.WriteHeader(200)
|
|
|
|
// layers[0] is the blob []byte("a")
|
|
w.Write([]byte(
|
|
`{ "schemaVersion": 2, "config": {
|
|
"mediaType": "application/vnd.cncf.helm.config.v1+json",
|
|
"digest": "sha256:a705ee2789ab50a5ba20930f246dbd5cc01ff9712825bb98f57ee8414377f133",
|
|
"size": 181
|
|
},
|
|
"layers": [
|
|
{
|
|
"mediaType": "application/tar+gzip",
|
|
"digest": "sha256:ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb",
|
|
"size": 1
|
|
}
|
|
]
|
|
}`))
|
|
} else if r.URL.Path == "/v2/testrepo/supposedlysafechart/blobs/sha256:a705ee2789ab50a5ba20930f246dbd5cc01ff9712825bb98f57ee8414377f133" {
|
|
w.Header().Set("Content-Type", "application/json")
|
|
w.WriteHeader(200)
|
|
w.Write([]byte("{\"name\":\"mychart\",\"version\":\"0.1.0\",\"description\":\"A Helm chart for Kubernetes\\n" +
|
|
"an 'application' or a 'library' chart.\",\"apiVersion\":\"v2\",\"appVersion\":\"1.16.0\",\"type\":" +
|
|
"\"application\"}"))
|
|
} else if r.URL.Path == "/v2/testrepo/supposedlysafechart/blobs/sha256:ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb" {
|
|
w.Header().Set("Content-Type", "application/tar+gzip")
|
|
w.WriteHeader(200)
|
|
w.Write([]byte("b"))
|
|
} else {
|
|
w.WriteHeader(500)
|
|
}
|
|
}))
|
|
|
|
u, _ := url.Parse(s.URL)
|
|
return fmt.Sprintf("localhost:%s", u.Port())
|
|
}
|