plugin_repo.go

package helpers

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"os"
	"path/filepath"

	"code.cloudfoundry.org/cli/util"
	"code.cloudfoundry.org/cli/util/generic"

	. "github.com/onsi/gomega"
	. "github.com/onsi/gomega/ghttp"
)

// Binary represents the metadata need to retrieve one of the binaries that makes up a plugin.
type Binary struct {
	Checksum string `json:"checksum"`
	Platform string `json:"platform"`
	URL      string `json:"url"`
}

// Plugin represents a plugin object provided by a plugin repo.
type Plugin struct {
	Name     string   `json:"name"`
	Version  string   `json:"version"`
	Binaries []Binary `json:"binaries"`
}

// PluginRepository represents a repo response object describing a list of plugins available.
type PluginRepository struct {
	Plugins []Plugin `json:"plugins"`
}

// PluginRepositoryServerWithPlugin represents a server used to provide downloadable plugins.
type PluginRepositoryServerWithPlugin struct {
	server     *Server
	pluginPath string
}

// NewPluginRepositoryServer is used to configure and start a new plugin repo server, exposing the plugins contained
// in the pluginRepo.
func NewPluginRepositoryServer(pluginRepo PluginRepository) *Server {
	return configurePluginRepositoryServer(NewTLSServer(), pluginRepo)
}

// NewPluginRepositoryServerWithPlugin is used to create a server to provide a single configurable_plugin
// with user provided name, version, and platform.
func NewPluginRepositoryServerWithPlugin(pluginType string, pluginName string, version string, platform string, shouldCalculateChecksum bool) *PluginRepositoryServerWithPlugin {
	pluginRepoServer := PluginRepositoryServerWithPlugin{}

	pluginRepoServer.Init(pluginType, pluginName, version, platform, shouldCalculateChecksum)

	return &pluginRepoServer
}

// Init initializes a server to provide a single configurable_plugin with user provided name, version, and platform.
func (pluginRepoServer *PluginRepositoryServerWithPlugin) Init(pluginType string, pluginName string, version string, platform string, shouldCalculateChecksum bool) {
	pluginPath := BuildConfigurablePlugin(pluginType, pluginName, version,
		[]PluginCommand{
			{Name: "some-command", Help: "some-command-help"},
		},
	)

	repoServer := NewServer()

	pluginRepoServer.server = repoServer
	pluginRepoServer.pluginPath = pluginPath

	var (
		checksum []byte
		err      error
	)

	if shouldCalculateChecksum {
		checksum, err = util.NewSha1Checksum(pluginPath).ComputeFileSha1()
		Expect(err).NotTo(HaveOccurred())
	}

	baseFile := fmt.Sprintf("/%s", generic.ExecutableFilename(filepath.Base(pluginPath)))
	downloadURL := fmt.Sprintf("%s%s", repoServer.URL(), baseFile)
	pluginRepo := PluginRepository{
		Plugins: []Plugin{
			{
				Name:    pluginName,
				Version: version,
				Binaries: []Binary{
					{
						Checksum: fmt.Sprintf("%x", checksum),
						Platform: platform,
						URL:      downloadURL,
					},
				},
			},
		}}

	// Suppresses ginkgo server logs
	repoServer.HTTPTestServer.Config.ErrorLog = log.New(&bytes.Buffer{}, "", 0)

	jsonBytes, err := json.Marshal(pluginRepo)
	Expect(err).ToNot(HaveOccurred())

	pluginData, err := ioutil.ReadFile(pluginPath)
	Expect(err).ToNot(HaveOccurred())

	repoServer.AppendHandlers(
		CombineHandlers(
			VerifyRequest(http.MethodGet, "/list"),
			RespondWith(http.StatusOK, jsonBytes),
		),
		CombineHandlers(
			VerifyRequest(http.MethodGet, "/list"),
			RespondWith(http.StatusOK, jsonBytes),
		),
		CombineHandlers(
			VerifyRequest(http.MethodGet, baseFile),
			RespondWith(http.StatusOK, pluginData),
		),
	)
}

// PluginSize is used to get the size in bytes of the single plugin provided by the pluginRepoServer
func (pluginRepoServer *PluginRepositoryServerWithPlugin) PluginSize() int64 {
	fileinfo, err := os.Stat(pluginRepoServer.pluginPath)
	Expect(err).NotTo(HaveOccurred())
	return fileinfo.Size()
}

// URL is used to get the pluginRepo's server url
func (pluginRepoServer *PluginRepositoryServerWithPlugin) URL() string {
	return pluginRepoServer.server.URL()
}

// Close is used to destroy the repo server and cleanup any files
func (pluginRepoServer *PluginRepositoryServerWithPlugin) Cleanup() {
	pluginRepoServer.server.Close()
	Expect(os.RemoveAll(filepath.Dir(pluginRepoServer.pluginPath))).NotTo(HaveOccurred())
}

// NewPluginRepositoryTLSServer is used to configure and start a new TLS plugin repo server, exposing the plugins contained
// in the pluginRepo.
func NewPluginRepositoryTLSServer(pluginRepo PluginRepository) *Server {
	return configurePluginRepositoryServer(NewTLSServer(), pluginRepo)
}

func configurePluginRepositoryServer(server *Server, pluginRepo PluginRepository) *Server {
	// Suppresses ginkgo server logs
	server.HTTPTestServer.Config.ErrorLog = log.New(&bytes.Buffer{}, "", 0)

	jsonBytes, err := json.Marshal(pluginRepo)
	Expect(err).ToNot(HaveOccurred())

	server.AppendHandlers(
		RespondWith(http.StatusOK, string(jsonBytes)),
		RespondWith(http.StatusOK, string(jsonBytes)),
		RespondWith(http.StatusOK, string(jsonBytes)),
		RespondWith(http.StatusOK, string(jsonBytes)),
	)

	return server
}