mirror of https://github.com/helm/helm
Merge pull request #3041 from jlyheden/feature/plugin-http-installer
Add plugin installer from http archivepull/2819/merge
Matthew Fisher
7 years ago
committed by
GitHub
commit
d655911088
@ -0,0 +1,207 @@
|
||||
/*
|
||||
Copyright 2016 The Kubernetes Authors All rights reserved.
|
||||
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 installer // import "k8s.io/helm/pkg/plugin/installer"
|
||||
|
||||
import (
|
||||
"archive/tar"
|
||||
"bytes"
|
||||
"compress/gzip"
|
||||
"fmt"
|
||||
"io"
|
||||
"k8s.io/helm/pkg/getter"
|
||||
"k8s.io/helm/pkg/helm/environment"
|
||||
"k8s.io/helm/pkg/helm/helmpath"
|
||||
"k8s.io/helm/pkg/plugin/cache"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// HTTPInstaller installs plugins from an archive served by a web server.
|
||||
type HTTPInstaller struct {
|
||||
CacheDir string
|
||||
PluginName string
|
||||
base
|
||||
extractor Extractor
|
||||
getter getter.Getter
|
||||
}
|
||||
|
||||
// TarGzExtractor extracts gzip compressed tar archives
|
||||
type TarGzExtractor struct{}
|
||||
|
||||
// Extractor provides an interface for extracting archives
|
||||
type Extractor interface {
|
||||
Extract(buffer *bytes.Buffer, targetDir string) error
|
||||
}
|
||||
|
||||
// Extractors contains a map of suffixes and matching implementations of extractor to return
|
||||
var Extractors = map[string]Extractor{
|
||||
".tar.gz": &TarGzExtractor{},
|
||||
".tgz": &TarGzExtractor{},
|
||||
}
|
||||
|
||||
// NewExtractor creates a new extractor matching the source file name
|
||||
func NewExtractor(source string) (Extractor, error) {
|
||||
for suffix, extractor := range Extractors {
|
||||
if strings.HasSuffix(source, suffix) {
|
||||
return extractor, nil
|
||||
}
|
||||
}
|
||||
return nil, fmt.Errorf("no extractor implemented yet for %s", source)
|
||||
}
|
||||
|
||||
// NewHTTPInstaller creates a new HttpInstaller.
|
||||
func NewHTTPInstaller(source string, home helmpath.Home) (*HTTPInstaller, error) {
|
||||
|
||||
key, err := cache.Key(source)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
extractor, err := NewExtractor(source)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
getConstructor, err := getter.ByScheme("http", environment.EnvSettings{})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
get, err := getConstructor.New(source, "", "", "")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
i := &HTTPInstaller{
|
||||
CacheDir: home.Path("cache", "plugins", key),
|
||||
PluginName: stripPluginName(filepath.Base(source)),
|
||||
base: newBase(source, home),
|
||||
extractor: extractor,
|
||||
getter: get,
|
||||
}
|
||||
return i, nil
|
||||
}
|
||||
|
||||
// helper that relies on some sort of convention for plugin name (plugin-name-<version>)
|
||||
func stripPluginName(name string) string {
|
||||
var strippedName string
|
||||
for suffix := range Extractors {
|
||||
if strings.HasSuffix(name, suffix) {
|
||||
strippedName = strings.TrimSuffix(name, suffix)
|
||||
break
|
||||
}
|
||||
}
|
||||
re := regexp.MustCompile(`(.*)-[0-9]+\..*`)
|
||||
return re.ReplaceAllString(strippedName, `$1`)
|
||||
}
|
||||
|
||||
// Install downloads and extracts the tarball into the cache directory and creates a symlink to the plugin directory in $HELM_HOME.
|
||||
//
|
||||
// Implements Installer.
|
||||
func (i *HTTPInstaller) Install() error {
|
||||
|
||||
pluginData, err := i.getter.Get(i.Source)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
err = i.extractor.Extract(pluginData, i.CacheDir)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if !isPlugin(i.CacheDir) {
|
||||
return ErrMissingMetadata
|
||||
}
|
||||
|
||||
src, err := filepath.Abs(i.CacheDir)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return i.link(src)
|
||||
}
|
||||
|
||||
// Update updates a local repository
|
||||
// Not implemented for now since tarball most likely will be packaged by version
|
||||
func (i *HTTPInstaller) Update() error {
|
||||
return fmt.Errorf("method Update() not implemented for HttpInstaller")
|
||||
}
|
||||
|
||||
// Override link because we want to use HttpInstaller.Path() not base.Path()
|
||||
func (i *HTTPInstaller) link(from string) error {
|
||||
debug("symlinking %s to %s", from, i.Path())
|
||||
return os.Symlink(from, i.Path())
|
||||
}
|
||||
|
||||
// Path is overridden because we want to join on the plugin name not the file name
|
||||
func (i HTTPInstaller) Path() string {
|
||||
if i.base.Source == "" {
|
||||
return ""
|
||||
}
|
||||
return filepath.Join(i.base.HelmHome.Plugins(), i.PluginName)
|
||||
}
|
||||
|
||||
// Extract extracts compressed archives
|
||||
//
|
||||
// Implements Extractor.
|
||||
func (g *TarGzExtractor) Extract(buffer *bytes.Buffer, targetDir string) error {
|
||||
uncompressedStream, err := gzip.NewReader(buffer)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
tarReader := tar.NewReader(uncompressedStream)
|
||||
|
||||
os.MkdirAll(targetDir, 0755)
|
||||
|
||||
for true {
|
||||
header, err := tarReader.Next()
|
||||
|
||||
if err == io.EOF {
|
||||
break
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
path := filepath.Join(targetDir, header.Name)
|
||||
|
||||
switch header.Typeflag {
|
||||
case tar.TypeDir:
|
||||
if err := os.Mkdir(path, 0755); err != nil {
|
||||
return err
|
||||
}
|
||||
case tar.TypeReg:
|
||||
outFile, err := os.Create(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer outFile.Close()
|
||||
if _, err := io.Copy(outFile, tarReader); err != nil {
|
||||
return err
|
||||
}
|
||||
default:
|
||||
return fmt.Errorf("unknown type: %b in %s", header.Typeflag, header.Name)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
|
||||
}
|
||||
@ -0,0 +1,189 @@
|
||||
/*
|
||||
Copyright 2016 The Kubernetes Authors All rights reserved.
|
||||
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 installer // import "k8s.io/helm/pkg/plugin/installer"
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/base64"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"k8s.io/helm/pkg/helm/helmpath"
|
||||
"os"
|
||||
"testing"
|
||||
)
|
||||
|
||||
var _ Installer = new(HTTPInstaller)
|
||||
|
||||
// Fake http client
|
||||
type TestHTTPGetter struct {
|
||||
MockResponse *bytes.Buffer
|
||||
MockError error
|
||||
}
|
||||
|
||||
func (t *TestHTTPGetter) Get(href string) (*bytes.Buffer, error) { return t.MockResponse, t.MockError }
|
||||
|
||||
// Fake plugin tarball data
|
||||
var fakePluginB64 = "H4sIAKRj51kAA+3UX0vCUBgGcC9jn+Iwuk3Peza3GeyiUlJQkcogCOzgli7dJm4TvYk+a5+k479UqquUCJ/fLs549sLO2TnvWnJa9aXnjwujYdYLovxMhsPcfnHOLdNkOXthM/IVQQYjg2yyLLJ4kXGhLp5j0z3P41tZksqxmspL3B/O+j/XtZu1y8rdYzkOZRCxduKPk53ny6Wwz/GfIIf1As8lxzGJSmoHNLJZphKHG4YpTCE0wVk3DULfpSJ3DMMqkj3P5JfMYLdX1Vr9Ie/5E5cstcdC8K04iGLX5HaJuKpWL17F0TCIBi5pf/0pjtLhun5j3f9v6r7wfnI/H0eNp9d1/5P6Gez0vzo7wsoxfrAZbTny/o9k6J8z/VkO/LPlWdC1iVpbEEcq5nmeJ13LEtmbV0k2r2PrOs9PuuNglC5rL1Y5S/syXRQmutaNw1BGnnp8Wq3UG51WvX1da3bKtZtCN/R09DwAAAAAAAAAAAAAAAAAAADAb30AoMczDwAoAAA="
|
||||
|
||||
func TestStripName(t *testing.T) {
|
||||
if stripPluginName("fake-plugin-0.0.1.tar.gz") != "fake-plugin" {
|
||||
t.Errorf("name does not match expected value")
|
||||
}
|
||||
if stripPluginName("fake-plugin-0.0.1.tgz") != "fake-plugin" {
|
||||
t.Errorf("name does not match expected value")
|
||||
}
|
||||
if stripPluginName("fake-plugin.tgz") != "fake-plugin" {
|
||||
t.Errorf("name does not match expected value")
|
||||
}
|
||||
if stripPluginName("fake-plugin.tar.gz") != "fake-plugin" {
|
||||
t.Errorf("name does not match expected value")
|
||||
}
|
||||
}
|
||||
|
||||
func TestHTTPInstaller(t *testing.T) {
|
||||
source := "https://repo.localdomain/plugins/fake-plugin-0.0.1.tar.gz"
|
||||
hh, err := ioutil.TempDir("", "helm-home-")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(hh)
|
||||
|
||||
home := helmpath.Home(hh)
|
||||
if err := os.MkdirAll(home.Plugins(), 0755); err != nil {
|
||||
t.Fatalf("Could not create %s: %s", home.Plugins(), err)
|
||||
}
|
||||
|
||||
i, err := NewForSource(source, "0.0.1", home)
|
||||
if err != nil {
|
||||
t.Errorf("unexpected error: %s", err)
|
||||
}
|
||||
|
||||
// ensure a HTTPInstaller was returned
|
||||
httpInstaller, ok := i.(*HTTPInstaller)
|
||||
if !ok {
|
||||
t.Error("expected a HTTPInstaller")
|
||||
}
|
||||
|
||||
// inject fake http client responding with minimal plugin tarball
|
||||
mockTgz, err := base64.StdEncoding.DecodeString(fakePluginB64)
|
||||
if err != nil {
|
||||
t.Fatalf("Could not decode fake tgz plugin: %s", err)
|
||||
}
|
||||
|
||||
httpInstaller.getter = &TestHTTPGetter{
|
||||
MockResponse: bytes.NewBuffer(mockTgz),
|
||||
}
|
||||
|
||||
// install the plugin
|
||||
if err := Install(i); err != nil {
|
||||
t.Error(err)
|
||||
}
|
||||
if i.Path() != home.Path("plugins", "fake-plugin") {
|
||||
t.Errorf("expected path '$HELM_HOME/plugins/fake-plugin', got %q", i.Path())
|
||||
}
|
||||
|
||||
// Install again to test plugin exists error
|
||||
if err := Install(i); err == nil {
|
||||
t.Error("expected error for plugin exists, got none")
|
||||
} else if err.Error() != "plugin already exists" {
|
||||
t.Errorf("expected error for plugin exists, got (%v)", err)
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
func TestHTTPInstallerNonExistentVersion(t *testing.T) {
|
||||
source := "https://repo.localdomain/plugins/fake-plugin-0.0.2.tar.gz"
|
||||
hh, err := ioutil.TempDir("", "helm-home-")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(hh)
|
||||
|
||||
home := helmpath.Home(hh)
|
||||
if err := os.MkdirAll(home.Plugins(), 0755); err != nil {
|
||||
t.Fatalf("Could not create %s: %s", home.Plugins(), err)
|
||||
}
|
||||
|
||||
i, err := NewForSource(source, "0.0.2", home)
|
||||
if err != nil {
|
||||
t.Errorf("unexpected error: %s", err)
|
||||
}
|
||||
|
||||
// ensure a HTTPInstaller was returned
|
||||
httpInstaller, ok := i.(*HTTPInstaller)
|
||||
if !ok {
|
||||
t.Error("expected a HTTPInstaller")
|
||||
}
|
||||
|
||||
// inject fake http client responding with error
|
||||
httpInstaller.getter = &TestHTTPGetter{
|
||||
MockError: fmt.Errorf("failed to download plugin for some reason"),
|
||||
}
|
||||
|
||||
// attempt to install the plugin
|
||||
if err := Install(i); err == nil {
|
||||
t.Error("expected error from http client")
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
func TestHTTPInstallerUpdate(t *testing.T) {
|
||||
source := "https://repo.localdomain/plugins/fake-plugin-0.0.1.tar.gz"
|
||||
hh, err := ioutil.TempDir("", "helm-home-")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(hh)
|
||||
|
||||
home := helmpath.Home(hh)
|
||||
if err := os.MkdirAll(home.Plugins(), 0755); err != nil {
|
||||
t.Fatalf("Could not create %s: %s", home.Plugins(), err)
|
||||
}
|
||||
|
||||
i, err := NewForSource(source, "0.0.1", home)
|
||||
if err != nil {
|
||||
t.Errorf("unexpected error: %s", err)
|
||||
}
|
||||
|
||||
// ensure a HTTPInstaller was returned
|
||||
httpInstaller, ok := i.(*HTTPInstaller)
|
||||
if !ok {
|
||||
t.Error("expected a HTTPInstaller")
|
||||
}
|
||||
|
||||
// inject fake http client responding with minimal plugin tarball
|
||||
mockTgz, err := base64.StdEncoding.DecodeString(fakePluginB64)
|
||||
if err != nil {
|
||||
t.Fatalf("Could not decode fake tgz plugin: %s", err)
|
||||
}
|
||||
|
||||
httpInstaller.getter = &TestHTTPGetter{
|
||||
MockResponse: bytes.NewBuffer(mockTgz),
|
||||
}
|
||||
|
||||
// install the plugin before updating
|
||||
if err := Install(i); err != nil {
|
||||
t.Error(err)
|
||||
}
|
||||
if i.Path() != home.Path("plugins", "fake-plugin") {
|
||||
t.Errorf("expected path '$HELM_HOME/plugins/fake-plugin', got %q", i.Path())
|
||||
}
|
||||
|
||||
// Update plugin, should fail because it is not implemented
|
||||
if err := Update(i); err == nil {
|
||||
t.Error("update method not implemented for http installer")
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue