Work in progress to refactor registry interface.

pull/178/head
jackgr 9 years ago
parent 17f22d777f
commit 4ffe342272

@ -178,12 +178,21 @@ type RegistryCredential struct {
BasicAuth BasicAuthCredential `json:"basicauth,omitempty"` BasicAuth BasicAuthCredential `json:"basicauth,omitempty"`
} }
// Registry describes a template registry
// TODO(jackr): Fix ambiguity re: whether or not URL has a scheme.
type Registry struct { type Registry struct {
Name string `json:"name,omitempty"` // Friendly name for the repo Name string `json:"name,omitempty"` // Friendly name for the registry
Type RegistryType `json:"type,omitempty"` // Technology implementing the registry Type RegistryType `json:"type,omitempty"` // Technology implementing the registry
URL string `json:"name,omitempty"` // URL to the root of the repo, for example: github.com/helm/charts URL string `json:"name,omitempty"` // URL to the root of the registry
Format RegistryFormat `json:"format,omitempty"` // Format of the registry
}
// AuthenticatedRegistry describes a type registry with credentials.
// Broke this out of Registry, so that we can pass around instances of Registry
// without worrying about secrets.
type AuthenticatedRegistry struct {
Registry
Credential RegistryCredential `json:"credential,omitempty"` Credential RegistryCredential `json:"credential,omitempty"`
Format RegistryFormat `json:"format,omitempty"`
} }
// RegistryType defines the technology that implements the registry // RegistryType defines the technology that implements the registry
@ -193,10 +202,35 @@ const (
GithubRegistryType RegistryType = "github" GithubRegistryType RegistryType = "github"
) )
// RegistryFormat defines the format of the registry // RegistryFormat is a semi-colon delimited string that describes the format
// of a registry.
type RegistryFormat string type RegistryFormat string
const ( const (
VersionedRegistry RegistryFormat = "versioned" // Versioning.
// If a registry if versioned, then types appear under versions.
VersionedRegistry RegistryFormat = "versioned"
// If a registry is unversioned, then types appear under their names.
UnversionedRegistry RegistryFormat = "unversioned" UnversionedRegistry RegistryFormat = "unversioned"
// Organization.
// In a collection registry, types are grouped into collections.
CollectionRegistry RegistryFormat = "collection"
// In a one level registry, all types appear at the top level.
OneLevelRegistry RegistryFormat = "onelevel"
) )
// RegistryService maintains a set of registries that defines the scope of all
// registry based operations, such as search and type resolution.
type RegistryService interface {
// List all the registries
List() ([]*Registry, error)
// Create a new registry
Create(registry *Registry) error
// Get a registry
Get(name string) (*Registry, error)
// Delete a registry
Delete(name string) error
// Find a registry that backs the given URL
GetByURL(URL string) (*Registry, error)
}

@ -22,7 +22,6 @@ import (
"github.com/kubernetes/deployment-manager/common" "github.com/kubernetes/deployment-manager/common"
"github.com/kubernetes/deployment-manager/expandybird/expander" "github.com/kubernetes/deployment-manager/expandybird/expander"
"github.com/kubernetes/deployment-manager/registry" "github.com/kubernetes/deployment-manager/registry"
"github.com/kubernetes/deployment-manager/util"
"archive/tar" "archive/tar"
"bytes" "bytes"
@ -35,6 +34,7 @@ import (
"net/http" "net/http"
"net/url" "net/url"
"os" "os"
"path"
"strconv" "strconv"
"strings" "strings"
"time" "time"
@ -81,8 +81,15 @@ var usage = func() {
panic("\n") panic("\n")
} }
func getGitRegistry() (registry.Registry, error) { var provider = registry.NewDefaultRegistryProvider()
return registry.NewDefaultRegistryProvider().GetRegistryByURL(*template_registry)
func getGithubRegistry() registry.Registry {
git, err := provider.GetRegistryByShortURL(*template_registry)
if err != nil {
panic(fmt.Errorf("cannot open registry %s: %s", *template_registry, err))
}
return git
} }
func main() { func main() {
@ -107,30 +114,21 @@ func execute() {
switch args[0] { switch args[0] {
case "templates": case "templates":
git, err := getGitRegistry() git := getGithubRegistry()
types, err := git.ListTypes(nil)
if err != nil { if err != nil {
panic(fmt.Errorf("Cannot get registry %v", err)) panic(fmt.Errorf("cannot list types in registry %s: %s", *template_registry, err))
}
templates, err := git.List()
if err != nil {
panic(fmt.Errorf("Cannot list %v", err))
} }
fmt.Printf("Templates:\n") fmt.Printf("Templates:\n")
for _, t := range templates { for _, t := range types {
var typeSpec = "" fmt.Printf("%s\n", t.String())
if len(t.Collection) > 0 { urls, err := git.GetDownloadURLs(t)
typeSpec = t.Collection + "/" if err != nil {
} panic(fmt.Errorf("cannot get download urls for %s: %s", t, err))
typeSpec = typeSpec + t.Name
if len(t.Version) > 0 {
typeSpec = typeSpec + ":" + t.Version
} }
fmt.Printf("%s\n", typeSpec) for _, downloadURL := range urls {
fmt.Printf("\tshort URL: github.com/%s/%s\n", *template_registry, typeSpec)
fmt.Printf("\tdownload URL(s):\n")
for _, downloadURL := range getDownloadURLs(t) {
fmt.Printf("\t%s\n", downloadURL) fmt.Printf("\t%s\n", downloadURL)
} }
} }
@ -197,7 +195,7 @@ func execute() {
usage() usage()
} }
tUrls := getTypeURLs(args[1]) tUrls := getDownloadURLs(args[1])
var tUrl = "" var tUrl = ""
if len(tUrls) == 0 { if len(tUrls) == 0 {
// Type is most likely a primitive. // Type is most likely a primitive.
@ -268,46 +266,24 @@ func describeType(args []string) {
usage() usage()
} }
tUrls := getTypeURLs(args[1]) tUrls := getDownloadURLs(args[1])
if len(tUrls) == 0 { if len(tUrls) == 0 {
panic(fmt.Errorf("Invalid type name, must be a template URL or in the form \"<type-name>:<version>\": %s", args[1])) panic(fmt.Errorf("Invalid type name, must be a template URL or in the form \"<type-name>:<version>\": %s", args[1]))
} }
schemaUrl := tUrls[0] + ".schema" schemaUrl := tUrls[0] + ".schema"
fmt.Println(callHttp(schemaUrl, "GET", "get schema for type ("+tUrls[0]+")", nil)) fmt.Println(callHttp(schemaUrl, "GET", "get schema for type ("+tUrls[0]+")", nil))
} }
// getTypeURLs returns URLs or empty list if a primitive type. // getDownloadURLs returns URLs or empty list if a primitive type.
func getTypeURLs(tName string) []string { func getDownloadURLs(tName string) []string {
if util.IsHttpUrl(tName) { qName := path.Join(*template_registry, tName)
// User can pass raw URL to template. result, err := registry.GetDownloadURLs(provider, qName)
return []string{tName}
}
// User can pass registry type.
t := getRegistryType(tName)
if t == nil {
// Primitive types have no associated URL.
return []string{}
}
return getDownloadURLs(*t)
}
func getDownloadURLs(t registry.Type) []string {
git, err := getGitRegistry()
if err != nil {
panic(fmt.Errorf("Failed to get registry"))
}
urls, err := git.GetURLs(t)
if err != nil { if err != nil {
panic(fmt.Errorf("Failed to fetch type information for \"%s:%s\": %s", t.Name, t.Version, err)) panic(fmt.Errorf("cannot get URLs for %s: %s\n", tName, err))
} }
return urls return result
}
func isHttp(t string) bool {
return strings.HasPrefix(t, "http://") || strings.HasPrefix(t, "https://")
} }
func loadTemplate(args []string) *common.Template { func loadTemplate(args []string) *common.Template {
@ -343,8 +319,8 @@ func loadTemplate(args []string) *common.Template {
} }
} else { } else {
if len(args) < 3 { if len(args) < 3 {
if t := getRegistryType(args[1]); t != nil { if t, err := registry.ParseType(args[1]); err == nil {
template = buildTemplateFromType(*t) template = buildTemplateFromType(t)
} else { } else {
template, err = expander.NewTemplateFromRootTemplate(args[1]) template, err = expander.NewTemplateFromRootTemplate(args[1])
} }
@ -365,28 +341,6 @@ func loadTemplate(args []string) *common.Template {
return template return template
} }
// TODO: needs better validation that this is actually a registry type.
func getRegistryType(fullType string) *registry.Type {
tList := strings.Split(fullType, ":")
if len(tList) != 2 {
return nil
}
cList := strings.Split(tList[0], "/")
if len(cList) == 1 {
return &registry.Type{
Name: tList[0],
Version: tList[1],
}
} else {
return &registry.Type{
Collection: cList[0],
Name: cList[1],
Version: tList[1],
}
}
}
func buildTemplateFromType(t registry.Type) *common.Template { func buildTemplateFromType(t registry.Type) *common.Template {
props := make(map[string]interface{}) props := make(map[string]interface{})
if *properties != "" { if *properties != "" {
@ -409,11 +363,11 @@ func buildTemplateFromType(t registry.Type) *common.Template {
} }
// Name the deployment after the type name. // Name the deployment after the type name.
name := fmt.Sprintf("%s:%s", t.Name, t.Version) name := fmt.Sprintf("%s:%s", t.Name, t.GetVersion())
config := common.Configuration{Resources: []*common.Resource{&common.Resource{ config := common.Configuration{Resources: []*common.Resource{&common.Resource{
Name: name, Name: name,
Type: getDownloadURLs(t)[0], Type: getDownloadURLs(t.String())[0],
Properties: props, Properties: props,
}}} }}}

@ -18,6 +18,7 @@ package main
import ( import (
"encoding/json" "encoding/json"
"errors"
"flag" "flag"
"fmt" "fmt"
"io" "io"
@ -25,7 +26,9 @@ import (
"log" "log"
"net" "net"
"net/http" "net/http"
"net/url"
"os" "os"
"regexp"
"strings" "strings"
"github.com/ghodss/yaml" "github.com/ghodss/yaml"
@ -51,8 +54,8 @@ var deployments = []Route{
{"ListTypeInstances", "/types/{type}/instances", "GET", listTypeInstancesHandlerFunc, ""}, {"ListTypeInstances", "/types/{type}/instances", "GET", listTypeInstancesHandlerFunc, ""},
{"ListRegistries", "/registries", "GET", listRegistriesHandlerFunc, ""}, {"ListRegistries", "/registries", "GET", listRegistriesHandlerFunc, ""},
{"GetRegistry", "/registries/{registry}", "GET", getRegistryHandlerFunc, ""}, {"GetRegistry", "/registries/{registry}", "GET", getRegistryHandlerFunc, ""},
{"ListCharts", "/registries/{registry}/charts", "GET", listChartsHandlerFunc, ""}, {"ListRegistryTypes", "/registries/{registry}/types", "GET", listRegistryTypesHandlerFunc, ""},
{"GetChart", "/registries/{registry}/charts/{chart}", "GET", getChartHandlerFunc, ""}, {"GetDownloadURLs", "/registries/{registry}/types/{type}", "GET", getDownloadURLsHandlerFunc, ""},
} }
var ( var (
@ -210,13 +213,21 @@ func putDeploymentHandlerFunc(w http.ResponseWriter, r *http.Request) {
func getPathVariable(w http.ResponseWriter, r *http.Request, variable, handler string) (string, error) { func getPathVariable(w http.ResponseWriter, r *http.Request, variable, handler string) (string, error) {
vars := mux.Vars(r) vars := mux.Vars(r)
ret, ok := vars[variable] escaped, ok := vars[variable]
if !ok { if !ok {
e := fmt.Errorf("%s parameter not found in URL", variable) e := errors.New(fmt.Sprintf("%s name not found in URL", variable))
util.LogAndReturnError(handler, http.StatusBadRequest, e, w) util.LogAndReturnError(handler, http.StatusBadRequest, e, w)
return "", e return "", e
} }
return ret, nil
unescaped, err := url.QueryUnescape(escaped)
if err != nil {
e := fmt.Errorf("cannot decode name (%v)", variable)
util.LogAndReturnError(handler, http.StatusBadRequest, e, w)
return "", e
}
return unescaped, nil
} }
func getTemplate(w http.ResponseWriter, r *http.Request, handler string) *common.Template { func getTemplate(w http.ResponseWriter, r *http.Request, handler string) *common.Template {
@ -368,37 +379,53 @@ func getRegistryHandlerFunc(w http.ResponseWriter, r *http.Request) {
util.LogHandlerExitWithJSON(handler, w, cr, http.StatusOK) util.LogHandlerExitWithJSON(handler, w, cr, http.StatusOK)
} }
func listChartsHandlerFunc(w http.ResponseWriter, r *http.Request) { func listRegistryTypesHandlerFunc(w http.ResponseWriter, r *http.Request) {
handler := "manager: list charts" handler := "manager: list registry types"
util.LogHandlerEntry(handler, r) util.LogHandlerEntry(handler, r)
registryName, err := getPathVariable(w, r, "registry", handler) registryName, err := getPathVariable(w, r, "registry", handler)
if err != nil { if err != nil {
return return
} }
chartNames, err := backend.ListCharts(registryName) var regex *regexp.Regexp
regexString, err := getPathVariable(w, r, "regex", handler)
if err == nil {
regex, err = regexp.Compile(regexString)
if err != nil {
util.LogAndReturnError(handler, http.StatusInternalServerError, err, w)
return
}
}
registryTypes, err := backend.ListRegistryTypes(registryName, regex)
if err != nil { if err != nil {
util.LogAndReturnError(handler, http.StatusInternalServerError, err, w) util.LogAndReturnError(handler, http.StatusInternalServerError, err, w)
return return
} }
util.LogHandlerExitWithJSON(handler, w, chartNames, http.StatusOK) util.LogHandlerExitWithJSON(handler, w, registryTypes, http.StatusOK)
} }
func getChartHandlerFunc(w http.ResponseWriter, r *http.Request) { func getDownloadURLsHandlerFunc(w http.ResponseWriter, r *http.Request) {
handler := "manager: get chart" handler := "manager: get download URLs"
util.LogHandlerEntry(handler, r) util.LogHandlerEntry(handler, r)
registryName, err := getPathVariable(w, r, "registry", handler) registryName, err := getPathVariable(w, r, "registry", handler)
if err != nil { if err != nil {
return return
} }
chartName, err := getPathVariable(w, r, "chart", handler) typeName, err := getPathVariable(w, r, "type", handler)
if err != nil {
return
}
tt, err := registry.ParseType(typeName)
if err != nil { if err != nil {
util.LogAndReturnError(handler, http.StatusInternalServerError, err, w)
return return
} }
c, err := backend.GetChart(registryName, chartName) c, err := backend.GetDownloadURLs(registryName, tt)
if err != nil { if err != nil {
util.LogAndReturnError(handler, http.StatusBadRequest, err, w) util.LogAndReturnError(handler, http.StatusBadRequest, err, w)
return return

@ -6,7 +6,7 @@ you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -25,7 +25,6 @@ import (
"github.com/ghodss/yaml" "github.com/ghodss/yaml"
"github.com/kubernetes/deployment-manager/common" "github.com/kubernetes/deployment-manager/common"
"github.com/kubernetes/deployment-manager/util"
) )
const ( const (
@ -101,7 +100,7 @@ func walkLayout(l *common.Layout, imports []*common.ImportFile, toReplace map[st
for len(toVisit) > 0 { for len(toVisit) > 0 {
lr := toVisit[0] lr := toVisit[0]
nodeKey := lr.Resource.Name + layoutNodeKeySeparator + lr.Resource.Type nodeKey := lr.Resource.Name + layoutNodeKeySeparator + lr.Resource.Type
if len(lr.Layout.Resources) == 0 && util.IsTemplate(lr.Resource.Type, imports) { if len(lr.Layout.Resources) == 0 && isTemplate(lr.Resource.Type, imports) {
ret[nodeKey] = lr ret[nodeKey] = lr
} else if toReplace[nodeKey] != nil { } else if toReplace[nodeKey] != nil {
toReplace[nodeKey].Resources = lr.Resources toReplace[nodeKey].Resources = lr.Resources
@ -113,6 +112,17 @@ func walkLayout(l *common.Layout, imports []*common.ImportFile, toReplace map[st
return ret return ret
} }
// isTemplate returns whether a given type is a template.
func isTemplate(t string, imports []*common.ImportFile) bool {
for _, imp := range imports {
if imp.Name == t {
return true
}
}
return false
}
// ExpandTemplate expands the supplied template, and returns a configuration. // ExpandTemplate expands the supplied template, and returns a configuration.
// It will also update the imports in the provided template if any were added // It will also update the imports in the provided template if any were added
// during type resolution. // during type resolution.

@ -19,6 +19,8 @@ package manager
import ( import (
"fmt" "fmt"
"log" "log"
"net/url"
"regexp"
"time" "time"
"github.com/kubernetes/deployment-manager/common" "github.com/kubernetes/deployment-manager/common"
@ -50,9 +52,9 @@ type Manager interface {
GetRegistry(name string) (*common.Registry, error) GetRegistry(name string) (*common.Registry, error)
DeleteRegistry(name string) error DeleteRegistry(name string) error
// Charts // Registry Types
ListCharts(registryName string) ([]string, error) ListRegistryTypes(registryName string, regex *regexp.Regexp) ([]registry.Type, error)
GetChart(registryName, chartName string) (*registry.Chart, error) GetDownloadURLs(registryName string, t registry.Type) ([]*url.URL, error)
} }
type manager struct { type manager struct {
@ -60,7 +62,7 @@ type manager struct {
deployer Deployer deployer Deployer
repository repository.Repository repository repository.Repository
provider registry.RegistryProvider provider registry.RegistryProvider
service registry.RegistryService service common.RegistryService
} }
// NewManager returns a new initialized Manager. // NewManager returns a new initialized Manager.
@ -68,7 +70,7 @@ func NewManager(expander Expander,
deployer Deployer, deployer Deployer,
repository repository.Repository, repository repository.Repository,
provider registry.RegistryProvider, provider registry.RegistryProvider,
service registry.RegistryService) Manager { service common.RegistryService) Manager {
return &manager{expander, deployer, repository, provider, service} return &manager{expander, deployer, repository, provider, service}
} }
@ -363,22 +365,25 @@ func getResourceErrors(c *common.Configuration) []string {
return errs return errs
} }
// ListCharts retrieves the names of the charts in a given registry. // ListRegistryTypes lists types in a given registry whose string values
func (m *manager) ListCharts(registryName string) ([]string, error) { // conform to the supplied regular expression, or all types, if the regular
// expression is nil.
func (m *manager) ListRegistryTypes(registryName string, regex *regexp.Regexp) ([]registry.Type, error) {
r, err := m.provider.GetRegistryByName(registryName) r, err := m.provider.GetRegistryByName(registryName)
if err != nil { if err != nil {
return nil, err return nil, err
} }
return r.ListCharts() return r.ListTypes(regex)
} }
// GetChart retrieves a given chart in a given registry. // GetDownloadURLs returns the URLs required to download the contents
func (m *manager) GetChart(registryName, chartName string) (*registry.Chart, error) { // of a given type in a given registry.
func (m *manager) GetDownloadURLs(registryName string, t registry.Type) ([]*url.URL, error) {
r, err := m.provider.GetRegistryByName(registryName) r, err := m.provider.GetRegistryByName(registryName)
if err != nil { if err != nil {
return nil, err return nil, err
} }
return r.GetChart(chartName) return r.GetDownloadURLs(t)
} }

@ -230,121 +230,31 @@ func (repository *repositoryStub) GetManifest(d string, m string) (*common.Manif
return nil, errTest return nil, errTest
} }
func (r *repositoryStub) ListTypes() []string { func (tgr *repositoryStub) ListTypes() []string {
r.ListTypesCalled = true tgr.ListTypesCalled = true
return []string{} return []string{}
} }
func (r *repositoryStub) GetTypeInstances(t string) []*common.TypeInstance { func (tgr *repositoryStub) GetTypeInstances(t string) []*common.TypeInstance {
r.GetTypeInstancesCalled = true tgr.GetTypeInstancesCalled = true
return []*common.TypeInstance{} return []*common.TypeInstance{}
} }
func (r *repositoryStub) ClearTypeInstances(d string) { func (tgr *repositoryStub) ClearTypeInstances(d string) {
r.TypeInstancesCleared = true tgr.TypeInstancesCleared = true
} }
func (r *repositoryStub) SetTypeInstances(d string, is map[string][]*common.TypeInstance) { func (tgr *repositoryStub) SetTypeInstances(d string, is map[string][]*common.TypeInstance) {
for k, _ := range is { for k, _ := range is {
r.TypeInstances[d] = append(r.TypeInstances[d], k) tgr.TypeInstances[d] = append(tgr.TypeInstances[d], k)
} }
} }
type registryStub struct {
FailListCharts bool
FailGetChart bool
ListChartsCalled bool
GetChartCalled bool
}
func newRegistryStub() *registryStub {
ret := &registryStub{}
return ret
}
func (r *registryStub) reset() {
r.FailListCharts = false
r.FailGetChart = false
r.ListChartsCalled = false
r.GetChartCalled = false
}
var testRegistryName = "TestRegistry"
var testRegistryURL = "https://github.com/helm/charts"
var testChartName = "TestChart"
var testChart = registry.Chart{
Name: testChartName,
}
var testChartList = []string{testChartName, "TestChart2"}
func (r *registryStub) GetRegistryName() string {
return testRegistryName
}
func (r *registryStub) GetRegistryType() common.RegistryType {
return common.GithubRegistryType
}
func (r *registryStub) GetRegistryURL() string {
return testRegistryURL
}
func (r *registryStub) ListCharts() ([]string, error) {
if r.FailListCharts {
return nil, errTest
}
return testChartList, nil
}
func (r *registryStub) GetChart(chartName string) (*registry.Chart, error) {
if !r.FailGetChart {
if chartName == testChartName {
return &testChart, nil
}
}
return nil, errTest
}
// Deprecated: Use ListCharts, instead.
func (r *registryStub) List() ([]registry.Type, error) {
return []registry.Type{}, nil
}
// Deprecated: Use GetChart, instead.
func (r *registryStub) GetURLs(t registry.Type) ([]string, error) {
return []string{}, nil
}
type registryProviderStub struct {
FailGetGithubRegistry bool
FailGetGithubPackageRegistry bool
}
var testRegistryOwner = "TestOwner"
var testRegistryRepository = "TestRepository"
func newRegistryProviderStub() *registryProviderStub {
ret := &registryProviderStub{}
return ret
}
func (rp *registryProviderStub) GetRegistryByURL(URL string) (registry.Registry, error) {
return newRegistryStub(), nil
}
func (rp *registryProviderStub) GetRegistryByName(registryName string) (registry.Registry, error) {
return newRegistryStub(), nil
}
var testExpander = &expanderStub{} var testExpander = &expanderStub{}
var testRepository = newRepositoryStub() var testRepository = newRepositoryStub()
var testDeployer = newDeployerStub() var testDeployer = newDeployerStub()
var testRegistryService = registry.NewInmemRegistryService() var testRegistryService = registry.NewInmemRegistryService()
var testProvider = newRegistryProviderStub() var testProvider = newTestRegistryProvider("", nil)
var testManager = NewManager(testExpander, testDeployer, testRepository, testProvider, testRegistryService) var testManager = NewManager(testExpander, testDeployer, testRepository, testProvider, testRegistryService)
func TestListDeployments(t *testing.T) { func TestListDeployments(t *testing.T) {
@ -615,3 +525,23 @@ func TestListInstances(t *testing.T) {
t.Fatal("expected repository GetTypeInstances() call.") t.Fatal("expected repository GetTypeInstances() call.")
} }
} }
// TODO(jackgr): Implement TestListRegistryTypes
func TestListRegistryTypes(t *testing.T) {
/*
types, err := testManager.ListRegistryTypes("", nil)
if err != nil {
t.Fatalf("cannot list registry types: %s", err)
}
*/
}
// TODO(jackgr): Implement TestGetDownloadURLs
func TestGetDownloadURLs(t *testing.T) {
/*
urls, err := testManager.GetDownloadURLs("", registry.Type{})
if err != nil {
t.Fatalf("cannot list get download urls: %s", err)
}
*/
}

@ -0,0 +1,106 @@
/*
Copyright 2015 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 manager
import (
"fmt"
"net/url"
"regexp"
"strings"
"github.com/kubernetes/deployment-manager/common"
"github.com/kubernetes/deployment-manager/registry"
)
type urlAndError struct {
u string
e error
}
type testRegistryProvider struct {
r map[string]registry.Registry
}
func newTestRegistryProvider(shortURL string, tests map[registry.Type]urlAndError) registry.RegistryProvider {
r := make(map[string]registry.Registry)
r[shortURL] = &testGithubRegistry{tests}
return testRegistryProvider{r}
}
func (trp testRegistryProvider) GetRegistryByShortURL(URL string) (registry.Registry, error) {
for key, r := range trp.r {
if strings.HasPrefix(URL, key) {
return r, nil
}
}
return nil, fmt.Errorf("No registry found for %s", URL)
}
func (trp testRegistryProvider) GetRegistryByName(registryName string) (registry.Registry, error) {
panic(fmt.Errorf("GetRegistryByName should not be called in the test"))
}
func (trp testRegistryProvider) GetGithubRegistry(cr common.Registry) (registry.GithubRegistry, error) {
panic(fmt.Errorf("GetGithubRegistry should not be called in the test"))
}
type testGithubRegistry struct {
responses map[registry.Type]urlAndError
}
func (tgr testGithubRegistry) GetRegistryName() string {
panic(fmt.Errorf("GetRegistryName should not be called in the test"))
}
func (tgr testGithubRegistry) GetRegistryType() common.RegistryType {
return common.GithubRegistryType
}
func (tgr testGithubRegistry) GetRegistryShortURL() string {
panic(fmt.Errorf("GetRegistryShortURL should not be called in the test"))
}
func (tgr testGithubRegistry) GetRegistryFormat() common.RegistryFormat {
panic(fmt.Errorf("GetRegistryFormat should not be called in the test"))
}
func (tgr testGithubRegistry) GetRegistryOwner() string {
panic(fmt.Errorf("GetRegistryOwner should not be called in the test"))
}
func (tgr testGithubRegistry) GetRegistryRepository() string {
panic(fmt.Errorf("GetRegistryRepository should not be called in the test"))
}
func (tgr testGithubRegistry) GetRegistryPath() string {
panic(fmt.Errorf("GetRegistryPath should not be called in the test"))
}
func (tgr testGithubRegistry) ListTypes(regex *regexp.Regexp) ([]registry.Type, error) {
panic(fmt.Errorf("ListTypes should not be called in the test"))
}
func (tgr testGithubRegistry) GetDownloadURLs(t registry.Type) ([]*url.URL, error) {
ret := tgr.responses[t]
URL, err := url.Parse(ret.u)
if err != nil {
panic(err)
}
return []*url.URL{URL}, ret.e
}

@ -100,7 +100,7 @@ func (tr *typeResolver) ResolveTypes(config *common.Configuration, imports []*co
toFetch := make([]*fetchUnit, 0, tr.maxUrls) toFetch := make([]*fetchUnit, 0, tr.maxUrls)
for _, r := range config.Resources { for _, r := range config.Resources {
// Map the type to a fetchable URL (if applicable) or skip it if it's a non-fetchable type (primitive for example). // Map the type to a fetchable URL (if applicable) or skip it if it's a non-fetchable type (primitive for example).
urls, err := tr.MapFetchableURLs(r.Type) urls, err := registry.GetDownloadURLs(tr.rp, r.Type)
if err != nil { if err != nil {
return nil, resolverError(config, fmt.Errorf("Failed to understand download url for %s: %v", r.Type, err)) return nil, resolverError(config, fmt.Errorf("Failed to understand download url for %s: %v", r.Type, err))
} }
@ -168,7 +168,7 @@ func (tr *typeResolver) ResolveTypes(config *common.Configuration, imports []*co
for _, v := range s.Imports { for _, v := range s.Imports {
i := &common.ImportFile{Name: v.Name} i := &common.ImportFile{Name: v.Name}
var existingSchema string var existingSchema string
urls, conversionErr := tr.MapFetchableURLs(v.Path) urls, conversionErr := registry.GetDownloadURLs(tr.rp, v.Path)
if conversionErr != nil { if conversionErr != nil {
return nil, resolverError(config, fmt.Errorf("Failed to understand download url for %s: %v", v.Path, conversionErr)) return nil, resolverError(config, fmt.Errorf("Failed to understand download url for %s: %v", v.Path, conversionErr))
} }
@ -220,56 +220,6 @@ func (tr *typeResolver) ResolveTypes(config *common.Configuration, imports []*co
return ret, nil return ret, nil
} }
// MapFetchableUrls checks a type to see if it is either a short git hub url or a fully specified URL
// and returns the URL that should be used to fetch it. If the url is not fetchable (primitive type for
// example) will return empty string.
func (tr *typeResolver) MapFetchableURLs(t string) ([]string, error) {
if util.IsGithubShortType(t) {
return tr.ShortTypeToDownloadURLs(t)
} else if util.IsGithubShortPackageType(t) {
return tr.ShortTypeToPackageDownloadURLs(t)
} else if util.IsHttpUrl(t) {
return []string{t}, nil
}
return []string{}, nil
}
// ShortTypeToDownloadURLs converts a github URL into downloadable URL from github.
// Input must be of the type and is assumed to have been validated before this call:
// github.com/owner/repo/qualifier/type:version
// for example:
// github.com/kubernetes/application-dm-templates/storage/redis:v1
func (tr *typeResolver) ShortTypeToDownloadURLs(template string) ([]string, error) {
m := util.TemplateRegistryMatcher.FindStringSubmatch(template)
if len(m) != 6 {
return []string{}, fmt.Errorf("Failed to parse short github url: %s", template)
}
r, err := tr.rp.GetRegistryByURL(template)
if err != nil {
return []string{}, err
}
t := registry.Type{m[3], m[4], m[5]}
return r.GetURLs(t)
}
// ShortTypeToPackageDownloadURLs converts a github URL into downloadable URLs from github.
// Input must be of the type and is assumed to have been validated before this call:
// github.com/owner/repo/type
// for example:
// github.com/helm/charts/cassandra
func (tr *typeResolver) ShortTypeToPackageDownloadURLs(template string) ([]string, error) {
m := util.PackageRegistryMatcher.FindStringSubmatch(template)
if len(m) != 4 {
return []string{}, fmt.Errorf("Failed to parse short github url: %s", template)
}
r, err := tr.rp.GetRegistryByURL(template)
if err != nil {
return []string{}, err
}
t := registry.Type{Name: m[3]}
return r.GetURLs(t)
}
func parseContent(templates []string) (string, error) { func parseContent(templates []string) (string, error) {
if len(templates) == 1 { if len(templates) == 1 {
return templates[0], nil return templates[0], nil

@ -18,7 +18,6 @@ package manager
import ( import (
"errors" "errors"
"fmt"
"net/http" "net/http"
"reflect" "reflect"
"strings" "strings"
@ -58,108 +57,6 @@ func (tg *testGetter) Get(url string) (body string, code int, err error) {
return ret.resp, ret.code, ret.err return ret.resp, ret.code, ret.err
} }
type urlAndError struct {
u string
e error
}
type testRegistryProvider struct {
URLPrefix string
r map[string]registry.Registry
}
func newTestRegistryProvider(URLPrefix string, tests map[registry.Type]urlAndError, count int) registry.RegistryProvider {
r := make(map[string]registry.Registry)
r[URLPrefix] = &testGithubRegistry{tests, count}
return &testRegistryProvider{URLPrefix, r}
}
// Deprecated: Use GetRegistryByURL, instead.
func (trp *testRegistryProvider) GetRegistry(URL string) (registry.Registry, error) {
return trp.GetRegistryByURL(URL)
}
func (trp *testRegistryProvider) GetRegistryByURL(URL string) (registry.Registry, error) {
for key, r := range trp.r {
if strings.HasPrefix(URL, key) {
return r, nil
}
}
return nil, fmt.Errorf("No registry found for %s", URL)
}
func (trp *testRegistryProvider) GetRegistryByName(registryName string) (registry.Registry, error) {
return newRegistryStub(), nil
}
type testGithubRegistry struct {
responses map[registry.Type]urlAndError
count int
}
func (r *testGithubRegistry) GetRegistryName() string {
return ""
}
func (r *testGithubRegistry) GetRegistryType() common.RegistryType {
return common.GithubRegistryType
}
func (r *testGithubRegistry) GetRegistryURL() string {
return ""
}
func (r *testGithubRegistry) ListCharts() ([]string, error) {
return []string{}, fmt.Errorf("ListCharts should not be called in the test")
}
func (r *testGithubRegistry) GetChart(chartName string) (*registry.Chart, error) {
return nil, fmt.Errorf("GetChart should not be called in the test")
}
// Deprecated: Use GetChart, instead.
func (tgr *testGithubRegistry) GetURLs(t registry.Type) ([]string, error) {
tgr.count = tgr.count + 1
ret := tgr.responses[t]
return []string{ret.u}, ret.e
}
// Deprecated: Use ListCharts, instead.
func (tgr *testGithubRegistry) List() ([]registry.Type, error) {
return []registry.Type{}, fmt.Errorf("List should not be called in the test")
}
type testGithubPackageRegistry struct {
responses map[registry.Type]urlAndError
count int
}
func (tgr *testGithubPackageRegistry) GetURLs(t registry.Type) ([]string, error) {
tgr.count = tgr.count + 1
ret := tgr.responses[t]
return []string{ret.u}, ret.e
}
func (tgr *testGithubPackageRegistry) List() ([]registry.Type, error) {
return []registry.Type{}, fmt.Errorf("List should not be called in the test")
}
func testUrlConversionDriver(c resolverTestCase, tests map[string]urlAndError, t *testing.T) {
r := &typeResolver{
rp: c.registryProvider,
}
for in, expected := range tests {
actual, err := r.ShortTypeToDownloadURLs(in)
if err != expected.e {
t.Errorf("failed on: %s : expected error %v but got %v", in, expected.e, err)
}
if actual[0] != expected.u {
t.Errorf("failed on: %s : expected %s but got %v", in, expected.u, actual)
}
}
}
func testDriver(c resolverTestCase, t *testing.T) { func testDriver(c resolverTestCase, t *testing.T) {
g := &testGetter{test: t, responses: c.responses} g := &testGetter{test: t, responses: c.responses}
r := &typeResolver{ r := &typeResolver{
@ -376,40 +273,6 @@ func TestSharedImport(t *testing.T) {
testDriver(test, t) testDriver(test, t)
} }
func TestShortGithubUrlMapping(t *testing.T) {
githubUrlMaps := map[registry.Type]urlAndError{
registry.Type{"common", "replicatedservice", "v1"}: urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/common/replicatedservice/v1/replicatedservice.py", nil},
registry.Type{"storage", "redis", "v1"}: urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/storage/redis/v1/redis.jinja", nil},
}
tests := map[string]urlAndError{
"github.com/kubernetes/application-dm-templates/common/replicatedservice:v1": urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/common/replicatedservice/v1/replicatedservice.py", nil},
"github.com/kubernetes/application-dm-templates/storage/redis:v1": urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/storage/redis/v1/redis.jinja", nil},
}
test := resolverTestCase{
registryProvider: newTestRegistryProvider("github.com/kubernetes/application-dm-templates", githubUrlMaps, 2),
}
testUrlConversionDriver(test, tests, t)
}
func TestShortGithubUrlMappingDifferentOwnerAndRepo(t *testing.T) {
githubUrlMaps := map[registry.Type]urlAndError{
registry.Type{"common", "replicatedservice", "v1"}: urlAndError{"https://raw.githubusercontent.com/example/mytemplates/master/common/replicatedservice/v1/replicatedservice.py", nil},
registry.Type{"storage", "redis", "v1"}: urlAndError{"https://raw.githubusercontent.com/example/mytemplates/master/storage/redis/v1/redis.jinja", nil},
}
tests := map[string]urlAndError{
"github.com/example/mytemplates/common/replicatedservice:v1": urlAndError{"https://raw.githubusercontent.com/example/mytemplates/master/common/replicatedservice/v1/replicatedservice.py", nil},
"github.com/example/mytemplates/storage/redis:v1": urlAndError{"https://raw.githubusercontent.com/example/mytemplates/master/storage/redis/v1/redis.jinja", nil},
}
test := resolverTestCase{
registryProvider: newTestRegistryProvider("github.com/example/mytemplates", githubUrlMaps, 2),
}
testUrlConversionDriver(test, tests, t)
}
var templateShortGithubTemplate = ` var templateShortGithubTemplate = `
resources: resources:
- name: foo - name: foo
@ -438,8 +301,8 @@ func TestShortGithubUrl(t *testing.T) {
} }
githubUrlMaps := map[registry.Type]urlAndError{ githubUrlMaps := map[registry.Type]urlAndError{
registry.Type{"common", "replicatedservice", "v1"}: urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/common/replicatedservice/v1/replicatedservice.py", nil}, registry.NewTypeOrDie("common", "replicatedservice", "v1"): urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/common/replicatedservice/v1/replicatedservice.py", nil},
registry.Type{"common", "replicatedservice", "v2"}: urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/common/replicatedservice/v2/replicatedservice.py", nil}, registry.NewTypeOrDie("common", "replicatedservice", "v2"): urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/common/replicatedservice/v2/replicatedservice.py", nil},
} }
test := resolverTestCase{ test := resolverTestCase{
@ -447,7 +310,7 @@ func TestShortGithubUrl(t *testing.T) {
importOut: finalImports, importOut: finalImports,
urlcount: 4, urlcount: 4,
responses: responses, responses: responses,
registryProvider: newTestRegistryProvider("github.com/kubernetes/application-dm-templates", githubUrlMaps, 2), registryProvider: newTestRegistryProvider("github.com/kubernetes/application-dm-templates", githubUrlMaps),
} }
testDriver(test, t) testDriver(test, t)
} }

@ -20,12 +20,15 @@ import (
"github.com/google/go-github/github" "github.com/google/go-github/github"
"github.com/kubernetes/deployment-manager/common" "github.com/kubernetes/deployment-manager/common"
"fmt"
"log" "log"
"net/url"
"regexp"
"strings" "strings"
) )
// GithubPackageRegistry implements the Registry interface that talks to github and // GithubPackageRegistry implements the Registry interface that talks to github and
// expects packages in helm format without versioning and no qualifier in the path. // expects packages in helm format without versioning and no collection in the path.
// Format of the directory for a type is like so: // Format of the directory for a type is like so:
// package/ // package/
// Chart.yaml // Chart.yaml
@ -34,53 +37,23 @@ import (
// bar.yaml // bar.yaml
// ... // ...
type GithubPackageRegistry struct { type GithubPackageRegistry struct {
owner string githubRegistry
repository string
client *github.Client
} }
// NewGithubRegistry creates a Registry that can be used to talk to github. // NewGithubPackageRegistry creates a GithubPackageRegistry.
func NewGithubPackageRegistry(owner, repository string, client *github.Client) *GithubPackageRegistry { func NewGithubPackageRegistry(name, shortURL string, client *github.Client) (GithubPackageRegistry, error) {
return &GithubPackageRegistry{ format := fmt.Sprintf("%s;%s", common.UnversionedRegistry, common.OneLevelRegistry)
owner: owner, gr, err := newGithubRegistry(name, shortURL, common.RegistryFormat(format), client)
repository: repository, if err != nil {
client: client, return GithubPackageRegistry{}, err
} }
}
// GetRegistryName returns the name of this registry
func (g *GithubPackageRegistry) GetRegistryName() string {
// TODO(jackgr): implement this method
return ""
}
// GetRegistryType returns the type of this registry.
func (g *GithubPackageRegistry) GetRegistryType() common.RegistryType {
// TODO(jackgr): implement this method
return common.GithubRegistryType
}
// GetRegistryURL returns the URL for this registry.
func (g *GithubPackageRegistry) GetRegistryURL() string {
// TODO(jackgr): implement this method
return ""
}
// ListCharts lists the versioned chart names in this registry. return GithubPackageRegistry{githubRegistry: gr}, nil
func (g *GithubPackageRegistry) ListCharts() ([]string, error) {
// TODO(jackgr): implement this method
return []string{}, nil
} }
// GetChart fetches the contents of a given chart. // ListTypes lists types in this registry whose string values conform to the
func (g *GithubPackageRegistry) GetChart(chartName string) (*Chart, error) { // supplied regular expression, or all types, if the regular expression is nil.
// TODO(jackgr): implement this method func (g GithubPackageRegistry) ListTypes(regex *regexp.Regexp) ([]Type, error) {
return nil, nil
}
// Deprecated: Use ListCharts, instead.
// List the types from the Registry.
func (g *GithubPackageRegistry) List() ([]Type, error) {
// Just list all the types at the top level. // Just list all the types at the top level.
types, err := g.getDirs("") types, err := g.getDirs("")
if err != nil { if err != nil {
@ -103,33 +76,41 @@ func (g *GithubPackageRegistry) List() ([]Type, error) {
} }
} }
// TODO(jackgr): Use the supplied regex to filter the results.
return retTypes, nil return retTypes, nil
} }
// Deprecated: Use GetChart, instead. // GetDownloadURLs fetches the download URLs for a given Type.
// GetURLs fetches the download URLs for a given Type. func (g GithubPackageRegistry) GetDownloadURLs(t Type) ([]*url.URL, error) {
func (g *GithubPackageRegistry) GetURLs(t Type) ([]string, error) {
path, err := g.MakeRepositoryPath(t) path, err := g.MakeRepositoryPath(t)
if err != nil { if err != nil {
return []string{}, err return nil, err
} }
_, dc, _, err := g.client.Repositories.GetContents(g.owner, g.repository, path, nil) _, dc, _, err := g.client.Repositories.GetContents(g.owner, g.repository, path, nil)
if err != nil { if err != nil {
log.Printf("Failed to list package files at path: %s: %v", path, err) log.Printf("Failed to list package files at path: %s: %v", path, err)
return []string{}, err return nil, err
} }
downloadURLs := []string{}
downloadURLs := []*url.URL{}
for _, f := range dc { for _, f := range dc {
if *f.Type == "file" { if *f.Type == "file" {
if strings.HasSuffix(*f.Name, ".yaml") { if strings.HasSuffix(*f.Name, ".yaml") {
downloadURLs = append(downloadURLs, *f.DownloadURL) u, err := url.Parse(*f.DownloadURL)
if err != nil {
return nil, fmt.Errorf("cannot parse URL from %s: %s", *f.DownloadURL, err)
}
downloadURLs = append(downloadURLs, u)
} }
} }
} }
return downloadURLs, nil return downloadURLs, nil
} }
func (g *GithubPackageRegistry) getDirs(dir string) ([]string, error) { func (g GithubPackageRegistry) getDirs(dir string) ([]string, error) {
_, dc, _, err := g.client.Repositories.GetContents(g.owner, g.repository, dir, nil) _, dc, _, err := g.client.Repositories.GetContents(g.owner, g.repository, dir, nil)
if err != nil { if err != nil {
log.Printf("Failed to get contents at path: %s: %v", dir, err) log.Printf("Failed to get contents at path: %s: %v", dir, err)
@ -149,7 +130,7 @@ func (g *GithubPackageRegistry) getDirs(dir string) ([]string, error) {
// MakeRepositoryPath constructs a github path to a given type based on a repository, and type name. // MakeRepositoryPath constructs a github path to a given type based on a repository, and type name.
// The returned repository path will be of the form: // The returned repository path will be of the form:
// Type.Name/manifests // Type.Name/manifests
func (g *GithubPackageRegistry) MakeRepositoryPath(t Type) (string, error) { func (g GithubPackageRegistry) MakeRepositoryPath(t Type) (string, error) {
// Construct the return path // Construct the return path
return t.Name + "/manifests", nil return t.Name + "/manifests", nil
} }

@ -19,110 +19,110 @@ package registry
import ( import (
"github.com/google/go-github/github" "github.com/google/go-github/github"
"github.com/kubernetes/deployment-manager/common" "github.com/kubernetes/deployment-manager/common"
"github.com/kubernetes/deployment-manager/util"
"fmt" "fmt"
"log" "log"
"net/url"
"regexp"
"strings" "strings"
) )
// GithubRegistry implements the Registry interface that talks to github and // githubRegistry implements the Registry interface and talks to github.
// implements Deployment Manager templates registry. // The registry short URL and format determine how types are laid out in the
// A registry root must be a directory that contains all the available templates, // registry.
// one directory per template. Each template directory then contains version type githubRegistry struct {
// directories, each of which in turn contains all the files necessary for that name string
// version of the template. shortURL string
//
// For example, a template registry containing two versions of redis
// (implemented in jinja), and one version of replicatedservice (implemented
// in python) would have a directory structure that looks something like this:
// qualifier [optional] prefix to a virtual root within the repository.
// /redis
// /v1
// redis.jinja
// redis.jinja.schema
// /v2
// redis.jinja
// redis.jinja.schema
// /replicatedservice
// /v1
// replicatedservice.python
// replicatedservice.python.schema
type GithubRegistry struct {
owner string owner string
repository string repository string
path string path string
format common.RegistryFormat
client *github.Client client *github.Client
} }
// NewGithubRegistry creates a Registry that can be used to talk to github. // newGithubRegistry creates a githubRegistry.
func NewGithubRegistry(owner, repository, path string, client *github.Client) *GithubRegistry { func newGithubRegistry(name, shortURL string, format common.RegistryFormat, client *github.Client) (githubRegistry, error) {
return &GithubRegistry{ trimmed := util.TrimURLScheme(shortURL)
owner, repository, path, err := parseGithubShortURL(trimmed)
if err != nil {
return githubRegistry{}, fmt.Errorf("cannot create Github template registry %s: %s", name, err)
}
return githubRegistry{
name: name,
shortURL: trimmed,
owner: owner, owner: owner,
repository: repository, repository: repository,
path: path, path: path,
format: format,
client: client, client: client,
}, nil
}
func parseGithubShortURL(shortURL string) (string, string, string, error) {
if !strings.HasPrefix(shortURL, "github.com/") {
return "", "", "", fmt.Errorf("invalid Github short URL: %s", shortURL)
} }
tPath := strings.TrimPrefix(shortURL, "github.com/")
parts := strings.Split(tPath, "/")
// Handle the case where there's no path after owner and repository.
if len(parts) == 2 {
return parts[0], parts[1], "", nil
}
// Handle the case where there's a path after owner and repository.
if len(parts) == 3 {
return parts[0], parts[1], parts[2], nil
}
return "", "", "", fmt.Errorf("invalid Github short URL: %s", shortURL)
} }
// GetRegistryName returns the name of this registry // GetRegistryName returns the name of this registry
func (g *GithubRegistry) GetRegistryName() string { func (g githubRegistry) GetRegistryName() string {
// TODO(jackgr): implement this method return g.name
return ""
} }
// GetRegistryType returns the type of this registry. // GetRegistryType returns the type of this registry.
func (g *GithubRegistry) GetRegistryType() common.RegistryType { func (g githubRegistry) GetRegistryType() common.RegistryType {
// TODO(jackgr): implement this method
return common.GithubRegistryType return common.GithubRegistryType
} }
// GetRegistryURL returns the URL for this registry. // GetRegistryShortURL returns the short URL for this registry.
func (g *GithubRegistry) GetRegistryURL() string { func (g githubRegistry) GetRegistryShortURL() string {
// TODO(jackgr): implement this method return g.shortURL
return ""
} }
// ListCharts lists the versioned chart names in this registry. // GetRegistryFormat returns the format of this registry.
func (g *GithubRegistry) ListCharts() ([]string, error) { func (g githubRegistry) GetRegistryFormat() common.RegistryFormat {
var result []string return g.format
names, err := g.getDirs("") }
if err != nil {
log.Printf("Failed to fetch chart names from registry: %s/%s/%s", g.owner, g.repository, g.path)
return nil, err
}
// Fetch the chart names
for _, name := range names {
// Then fetch the versions for each chart name
versions, err := g.getDirs("/" + name)
if err != nil {
log.Printf("Failed to fetch versions for chart name: %s/%s/%s/%s",
g.owner, g.repository, g.path, name)
return nil, err
}
for _, version := range versions { // GetRegistryOwner returns the owner name for this registry
result = append(result, fmt.Sprintf("%s#%s", name, version)) func (g githubRegistry) GetRegistryOwner() string {
} return g.owner
} }
return result, nil // GetRegistryRepository returns the repository name for this registry.
func (g githubRegistry) GetRegistryRepository() string {
return g.repository
} }
// GetChart fetches the contents of a given chart. // GetRegistryName returns the name of this registry
func (g *GithubRegistry) GetChart(chartName string) (*Chart, error) { func (g githubRegistry) GetRegistryPath() string {
// TODO(jackgr): implement this method return g.path
return nil, nil
} }
// Deprecated: Use ListCharts, instead. // ListTypes lists types in this registry whose string values conform to the
// List the types from the Registry. // supplied regular expression, or all types, if the regular expression is nil.
func (g *GithubRegistry) List() ([]Type, error) { func (g githubRegistry) ListTypes(regex *regexp.Regexp) ([]Type, error) {
// First list all the collections at the top level. // First list all the collections at the top level.
collections, err := g.getDirs("") collections, err := g.getDirs("")
if err != nil { if err != nil {
log.Printf("Failed to list qualifiers: %v", err) log.Printf("cannot list qualifiers: %v", err)
return nil, err return nil, err
} }
@ -131,38 +131,45 @@ func (g *GithubRegistry) List() ([]Type, error) {
// Then we need to fetch the versions (directories for this type) // Then we need to fetch the versions (directories for this type)
types, err := g.getDirs(c) types, err := g.getDirs(c)
if err != nil { if err != nil {
log.Printf("Failed to fetch types for collection: %s", c) log.Printf("cannot fetch types for collection: %s", c)
return nil, err return nil, err
} }
for _, t := range types { for _, t := range types {
path := c + "/" + t
// Then we need to fetch the versions (directories for this type) // Then we need to fetch the versions (directories for this type)
versions, err := g.getDirs(c + "/" + t) versions, err := g.getDirs(path)
if err != nil { if err != nil {
log.Printf("Failed to fetch versions for template: %s", t) log.Printf("cannot fetch versions at path %s", path)
return nil, err return nil, err
} }
for _, v := range versions { for _, v := range versions {
retTypes = append(retTypes, Type{Name: t, Version: v, Collection: c}) tt, err := NewType(c, t, v)
if err != nil {
return nil, fmt.Errorf("malformed type at path %s", path)
}
retTypes = append(retTypes, tt)
} }
} }
} }
// TODO(jackgr): Use the supplied regex to filter the results.
return retTypes, nil return retTypes, nil
} }
// Deprecated: Use GetChart, instead. // GetDownloadURLs fetches the download URLs for a given Type and checks for existence of a schema file.
// GetURL fetches the download URL for a given Type and checks for existence of a schema file. func (g githubRegistry) GetDownloadURLs(t Type) ([]*url.URL, error) {
func (g *GithubRegistry) GetURLs(t Type) ([]string, error) {
path, err := g.MakeRepositoryPath(t) path, err := g.MakeRepositoryPath(t)
if err != nil { if err != nil {
return []string{}, err return nil, err
} }
_, dc, _, err := g.client.Repositories.GetContents(g.owner, g.repository, path, nil) _, dc, _, err := g.client.Repositories.GetContents(g.owner, g.repository, path, nil)
if err != nil { if err != nil {
log.Printf("Failed to list versions at path: %s: %v", path, err) return nil, fmt.Errorf("cannot list versions at path %s: %v", path, err)
return []string{}, err
} }
var downloadURL, typeName, schemaName string var downloadURL, typeName, schemaName string
for _, f := range dc { for _, f := range dc {
if *f.Type == "file" { if *f.Type == "file" {
@ -175,16 +182,24 @@ func (g *GithubRegistry) GetURLs(t Type) ([]string, error) {
} }
} }
} }
if downloadURL == "" { if downloadURL == "" {
return []string{}, fmt.Errorf("Can not find template %s:%s", t.Name, t.Version) return nil, fmt.Errorf("cannot find type %s", t.String())
}
if schemaName != typeName+".schema" {
return nil, fmt.Errorf("cannot find schema for %s, expected %s", t.String(), typeName+".schema")
} }
if schemaName == typeName+".schema" {
return []string{downloadURL}, nil result, err := url.Parse(downloadURL)
if err != nil {
return nil, fmt.Errorf("cannot parse URL from %s: %s", downloadURL, err)
} }
return []string{}, fmt.Errorf("Can not find schema for %s:%s, expected to find %s", t.Name, t.Version, typeName+".schema")
return []*url.URL{result}, nil
} }
func (g *GithubRegistry) getDirs(dir string) ([]string, error) { func (g githubRegistry) getDirs(dir string) ([]string, error) {
var path = g.path var path = g.path
if dir != "" { if dir != "" {
path = g.path + "/" + dir path = g.path + "/" + dir
@ -206,7 +221,7 @@ func (g *GithubRegistry) getDirs(dir string) ([]string, error) {
return dirs, nil return dirs, nil
} }
func (g *GithubRegistry) mapCollection(collection string) (string, error) { func (g githubRegistry) mapCollection(collection string) (string, error) {
if strings.ContainsAny(collection, "/") { if strings.ContainsAny(collection, "/") {
return "", fmt.Errorf("collection must not contain slashes, got %s", collection) return "", fmt.Errorf("collection must not contain slashes, got %s", collection)
} }
@ -216,10 +231,10 @@ func (g *GithubRegistry) mapCollection(collection string) (string, error) {
// MakeRepositoryPath constructs a github path to a given type based on a repository, and type name and version. // MakeRepositoryPath constructs a github path to a given type based on a repository, and type name and version.
// The returned repository path will be of the form: // The returned repository path will be of the form:
// [GithubRegistry.path/][Type.Collection]/Type.Name/Type.Version // [githubRegistry.path/][Type.Collection]/Type.Name/Type.Version
// Type.Collection will be mapped using mapCollection in the future, for now it's a straight // Type.Collection will be mapped using mapCollection in the future, for now it's a straight
// 1:1 mapping (if given) // 1:1 mapping (if given)
func (g *GithubRegistry) MakeRepositoryPath(t Type) (string, error) { func (g githubRegistry) MakeRepositoryPath(t Type) (string, error) {
// First map the collection // First map the collection
collection, err := g.mapCollection(t.Collection) collection, err := g.mapCollection(t.Collection)
if err != nil { if err != nil {
@ -233,5 +248,5 @@ func (g *GithubRegistry) MakeRepositoryPath(t Type) (string, error) {
if len(collection) > 0 { if len(collection) > 0 {
p += collection + "/" p += collection + "/"
} }
return p + t.Name + "/" + t.Version, nil return p + t.Name + "/" + t.GetVersion(), nil
} }

@ -0,0 +1,200 @@
/*
Copyright 2015 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 registry
import (
"github.com/google/go-github/github"
"github.com/kubernetes/deployment-manager/common"
"fmt"
"log"
"net/url"
"regexp"
"strings"
)
// GithubTemplateRegistry implements the Registry interface and implements a
// Deployment Manager templates registry.
// A registry root must be a directory that contains all the available templates,
// one directory per template. Each template directory then contains version
// directories, each of which in turn contains all the files necessary for that
// version of the template.
//
// For example, a template registry containing two versions of redis
// (implemented in jinja), and one version of replicatedservice (implemented
// in python) would have a directory structure that looks something like this:
// qualifier [optional] prefix to a virtual root within the repository.
// /redis
// /v1
// redis.jinja
// redis.jinja.schema
// /v2
// redis.jinja
// redis.jinja.schema
// /replicatedservice
// /v1
// replicatedservice.python
// replicatedservice.python.schema
type GithubTemplateRegistry struct {
githubRegistry
}
// NewGithubTemplateRegistry creates a GithubTemplateRegistry.
func NewGithubTemplateRegistry(name, shortURL string, client *github.Client) (GithubTemplateRegistry, error) {
format := fmt.Sprintf("%s;%s", common.VersionedRegistry, common.CollectionRegistry)
gr, err := newGithubRegistry(name, shortURL, common.RegistryFormat(format), client)
if err != nil {
return GithubTemplateRegistry{}, err
}
return GithubTemplateRegistry{githubRegistry: gr}, nil
}
// ListTypes lists types in this registry whose string values conform to the
// supplied regular expression, or all types, if the regular expression is nil.
func (g GithubTemplateRegistry) ListTypes(regex *regexp.Regexp) ([]Type, error) {
// First list all the collections at the top level.
collections, err := g.getDirs("")
if err != nil {
log.Printf("cannot list qualifiers: %v", err)
return nil, err
}
var retTypes []Type
for _, c := range collections {
// Then we need to fetch the versions (directories for this type)
types, err := g.getDirs(c)
if err != nil {
log.Printf("cannot fetch types for collection: %s", c)
return nil, err
}
for _, t := range types {
path := c + "/" + t
// Then we need to fetch the versions (directories for this type)
versions, err := g.getDirs(path)
if err != nil {
log.Printf("cannot fetch versions at path %s", path)
return nil, err
}
for _, v := range versions {
tt, err := NewType(c, t, v)
if err != nil {
return nil, fmt.Errorf("malformed type at path %s", path)
}
retTypes = append(retTypes, tt)
}
}
}
// TODO(jackgr): Use the supplied regex to filter the results.
return retTypes, nil
}
// GetDownloadURLs fetches the download URLs for a given Type and checks for existence of a schema file.
func (g GithubTemplateRegistry) GetDownloadURLs(t Type) ([]*url.URL, error) {
path, err := g.MakeRepositoryPath(t)
if err != nil {
return nil, err
}
_, dc, _, err := g.client.Repositories.GetContents(g.owner, g.repository, path, nil)
if err != nil {
return nil, fmt.Errorf("cannot list versions at path %s: %v", path, err)
}
var downloadURL, typeName, schemaName string
for _, f := range dc {
if *f.Type == "file" {
if *f.Name == t.Name+".jinja" || *f.Name == t.Name+".py" {
typeName = *f.Name
downloadURL = *f.DownloadURL
}
if *f.Name == t.Name+".jinja.schema" || *f.Name == t.Name+".py.schema" {
schemaName = *f.Name
}
}
}
if downloadURL == "" {
return nil, fmt.Errorf("cannot find type %s", t.String())
}
if schemaName != typeName+".schema" {
return nil, fmt.Errorf("cannot find schema for %s, expected %s", t.String(), typeName+".schema")
}
result, err := url.Parse(downloadURL)
if err != nil {
return nil, fmt.Errorf("cannot parse URL from %s: %s", downloadURL, err)
}
return []*url.URL{result}, nil
}
func (g GithubTemplateRegistry) getDirs(dir string) ([]string, error) {
var path = g.path
if dir != "" {
path = g.path + "/" + dir
}
_, dc, _, err := g.client.Repositories.GetContents(g.owner, g.repository, path, nil)
if err != nil {
log.Printf("Failed to get contents at path: %s: %v", path, err)
return nil, err
}
var dirs []string
for _, entry := range dc {
if *entry.Type == "dir" {
dirs = append(dirs, *entry.Name)
}
}
return dirs, nil
}
func (g GithubTemplateRegistry) mapCollection(collection string) (string, error) {
if strings.ContainsAny(collection, "/") {
return "", fmt.Errorf("collection must not contain slashes, got %s", collection)
}
// TODO(vaikas): Implement lookup from the root metadata file to map collection to a path
return collection, nil
}
// MakeRepositoryPath constructs a github path to a given type based on a repository, and type name and version.
// The returned repository path will be of the form:
// [GithubTemplateRegistry.path/][Type.Collection]/Type.Name/Type.Version
// Type.Collection will be mapped using mapCollection in the future, for now it's a straight
// 1:1 mapping (if given)
func (g GithubTemplateRegistry) MakeRepositoryPath(t Type) (string, error) {
// First map the collection
collection, err := g.mapCollection(t.Collection)
if err != nil {
return "", err
}
// Construct the return path
p := ""
if len(g.path) > 0 {
p += g.path + "/"
}
if len(collection) > 0 {
p += collection + "/"
}
return p + t.Name + "/" + t.GetVersion(), nil
}

@ -27,21 +27,25 @@ type inmemRegistryService struct {
registries map[string]*common.Registry registries map[string]*common.Registry
} }
func NewInmemRegistryService() RegistryService { func NewInmemRegistryService() common.RegistryService {
rs := &inmemRegistryService{ rs := &inmemRegistryService{
registries: make(map[string]*common.Registry), registries: make(map[string]*common.Registry),
} }
pFormat := fmt.Sprintf("%s;%s", common.UnversionedRegistry, common.OneLevelRegistry)
rs.Create(&common.Registry{ rs.Create(&common.Registry{
Name: "charts", Name: "charts",
Type: common.GithubRegistryType, Type: common.GithubRegistryType,
URL: "github.com/helm/charts", URL: "github.com/helm/charts",
Format: common.UnversionedRegistry, Format: common.RegistryFormat(pFormat),
}) })
tFormat := fmt.Sprintf("%s;%s", common.VersionedRegistry, common.CollectionRegistry)
rs.Create(&common.Registry{ rs.Create(&common.Registry{
Name: "application-dm-templates", Name: "application-dm-templates",
Type: common.GithubRegistryType, Type: common.GithubRegistryType,
URL: "github.com/kubernetes/application-dm-templates", URL: "github.com/kubernetes/application-dm-templates",
Format: common.VersionedRegistry, Format: common.RegistryFormat(tFormat),
}) })
return rs return rs
} }

@ -1,7 +1,7 @@
/* /*
Copyright 2015 The Kubernetes Authors All rights reserved. Copyright 2015 The Kubernetes Authors All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
@ -17,11 +17,12 @@ limitations under the License.
package registry package registry
import ( import (
"strings"
"github.com/kubernetes/deployment-manager/common" "github.com/kubernetes/deployment-manager/common"
"fmt"
"net/url" "net/url"
"regexp"
"strings"
) )
// Registry abstracts a registry that holds charts, which can be // Registry abstracts a registry that holds charts, which can be
@ -32,66 +33,110 @@ type Registry interface {
GetRegistryName() string GetRegistryName() string
// GetRegistryType returns the type of this registry. // GetRegistryType returns the type of this registry.
GetRegistryType() common.RegistryType GetRegistryType() common.RegistryType
// GetRegistryURL returns the URL for this registry. // GetRegistryShortURL returns the short URL for this registry.
GetRegistryURL() string GetRegistryShortURL() string
// GetRegistryFormat returns the format of this registry.
// ListCharts lists the versioned chart names in this registry. GetRegistryFormat() common.RegistryFormat
ListCharts() ([]string, error)
// GetChart fetches the contents of a given chart. // ListTypes lists types in this registry whose string values conform to the
GetChart(chartName string) (*Chart, error) // supplied regular expression, or all types, if the regular expression is nil.
ListTypes(regex *regexp.Regexp) ([]Type, error)
// Deprecated: Use ListCharts, instead. // GetDownloadURLs returns the URLs required to download the type contents.
List() ([]Type, error) GetDownloadURLs(t Type) ([]*url.URL, error)
// Deprecated: Use GetChart, instead.
GetURLs(t Type) ([]string, error)
} }
type RegistryService interface { // GithubRegistry abstracts a registry that resides in a Github repository.
// List all the registries type GithubRegistry interface {
List() ([]*common.Registry, error) Registry // A GithubRegistry is a Registry.
// Create a new registry // GetRegistryOwner returns the owner name for this registry
Create(registry *common.Registry) error GetRegistryOwner() string
// Get a registry // GetRegistryRepository returns the repository name for this registry.
Get(name string) (*common.Registry, error) GetRegistryRepository() string
// Delete a registry // GetRegistryPath returns the path to the registry in the repository.
Delete(name string) error GetRegistryPath() string
// Find a registry that backs the given URL
GetByURL(URL string) (*common.Registry, error)
} }
// Deprecated: Use Chart, instead
type Type struct { type Type struct {
Collection string Collection string
Name string Name string
Version string version SemVer
} }
// ParseType takes a registry name and parses it into a *registry.Type. // NewType initializes a type
func ParseType(name string) *Type { func NewType(collection, name, version string) (Type, error) {
tt := &Type{} result := Type{Collection: collection, Name: name}
err := result.SetVersion(version)
return result, err
}
tList := strings.Split(name, ":") // NewTypeOrDie initializes a type and panics if initialization fails
func NewTypeOrDie(collection, name, version string) Type {
result, err := NewType(collection, name, version)
if err != nil {
panic(err)
}
return result
}
// Type conforms to the Stringer interface.
func (t Type) String() string {
var result string
if t.Collection != "" {
result = t.Collection + "/"
}
result = result + t.Name
version := t.GetVersion()
if version != "" && version != "v0" {
result = result + ":" + version
}
return result
}
// GetVersion returns the type version with the letter "v" prepended.
func (t Type) GetVersion() string {
var result string
version := t.version.String()
if version != "0" {
result = "v" + version
}
return result
}
// SetVersion strips the letter "v" from version, if present,
// and sets the the version of the type to the result.
func (t *Type) SetVersion(version string) error {
vstring := strings.TrimPrefix(version, "v")
s, err := ParseSemVer(vstring)
if err != nil {
return err
}
t.version = s
return nil
}
// ParseType takes a registry type string and parses it into a *registry.Type.
// TODO: needs better validation that this is actually a registry type.
func ParseType(ts string) (Type, error) {
tt := Type{}
tList := strings.Split(ts, ":")
if len(tList) == 2 { if len(tList) == 2 {
tt.Version = tList[1] if err := tt.SetVersion(tList[1]); err != nil {
return tt, fmt.Errorf("malformed type string: %s", ts)
}
} }
cList := strings.Split(tList[0], "/") cList := strings.Split(tList[0], "/")
if len(cList) == 1 { if len(cList) == 1 {
tt.Name = tList[0] tt.Name = tList[0]
} else { } else {
tt.Collection = cList[0] tt.Collection = cList[0]
tt.Name = cList[1] tt.Name = cList[1]
} }
return tt
}
type Chart struct {
Name string
Version SemVer
RegistryURL string
DownloadURLs []url.URL
// TODO(jackgr): Should the metadata be strongly typed? return tt, nil
Metadata map[string]interface{}
} }

@ -1,114 +0,0 @@
/*
Copyright 2015 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 registry
import (
"fmt"
"strings"
"sync"
"github.com/google/go-github/github"
"github.com/kubernetes/deployment-manager/common"
)
// RegistryProvider returns factories for creating registry clients.
type RegistryProvider interface {
GetRegistryByURL(URL string) (Registry, error)
GetRegistryByName(registryName string) (Registry, error)
}
func NewDefaultRegistryProvider() RegistryProvider {
registries := make(map[string]Registry)
rs := NewInmemRegistryService()
return &DefaultRegistryProvider{registries: registries, rs: rs}
}
type DefaultRegistryProvider struct {
sync.RWMutex
registries map[string]Registry
rs RegistryService
}
func (drp *DefaultRegistryProvider) GetRegistryByURL(URL string) (Registry, error) {
drp.RLock()
defer drp.RUnlock()
ghr := drp.findRegistryByURL(URL)
if ghr == nil {
cr, err := drp.rs.GetByURL(URL)
if err != nil {
return nil, err
}
ghr, err := drp.getGithubRegistry(cr)
if err != nil {
return nil, err
}
drp.registries[ghr.GetRegistryName()] = ghr
}
return ghr, nil
}
func (drp *DefaultRegistryProvider) findRegistryByURL(URL string) Registry {
for _, ghr := range drp.registries {
if strings.HasPrefix(URL, ghr.GetRegistryURL()) {
return ghr
}
}
return nil
}
func (drp *DefaultRegistryProvider) GetRegistryByName(registryName string) (Registry, error) {
drp.RLock()
defer drp.RUnlock()
ghr, ok := drp.registries[registryName]
if !ok {
cr, err := drp.rs.Get(registryName)
if err != nil {
return nil, err
}
ghr, err := drp.getGithubRegistry(cr)
if err != nil {
return nil, err
}
drp.registries[ghr.GetRegistryName()] = ghr
}
return ghr, nil
}
func (drp *DefaultRegistryProvider) getGithubRegistry(cr *common.Registry) (Registry, error) {
// TODO(jackgr): Take owner and repository from cr instead of hard wiring
if cr.Type == common.GithubRegistryType {
switch cr.Format {
case common.UnversionedRegistry:
return NewGithubPackageRegistry("helm", "charts", github.NewClient(nil)), nil
case common.VersionedRegistry:
return NewGithubRegistry("kubernetes", "application-dm-templates", "", github.NewClient(nil)), nil
default:
return nil, fmt.Errorf("unknown registry format: %s", cr.Format)
}
}
return nil, fmt.Errorf("unknown registry type: %s", cr.Type)
}

@ -4,25 +4,36 @@ import (
"testing" "testing"
) )
func TestParseType(t *testing.T) { func TestTypeConversion(t *testing.T) {
// TODO: Are there some real-world examples we want to valide here? // TODO: Are there some real-world examples we want to validate here?
tests := map[string]*Type{ tests := map[string]Type{
"foo": &Type{Name: "foo"}, "foo": NewTypeOrDie("", "foo", ""),
"foo:v1": &Type{Name: "foo", Version: "v1"}, "foo:v1": NewTypeOrDie("", "foo", "v1"),
"github.com/foo": &Type{Name: "foo", Collection: "github.com"}, "github.com/foo": NewTypeOrDie("github.com", "foo", ""),
"github.com/foo:v1.2.3": &Type{Name: "foo", Collection: "github.com", Version: "v1.2.3"}, "github.com/foo:v1.2.3": NewTypeOrDie("github.com", "foo", "v1.2.3"),
} }
for in, expect := range tests { for in, expect := range tests {
out := ParseType(in) out, err := ParseType(in)
if err != nil {
t.Errorf("Error parsing type string %s: $s", in, err)
}
if out.Name != expect.Name { if out.Name != expect.Name {
t.Errorf("Expected name to be %q, got %q", expect.Name, out.Name) t.Errorf("Expected name to be %q, got %q", expect.Name, out.Name)
} }
if out.Version != expect.Version {
t.Errorf("Expected version to be %q, got %q", expect.Version, out.Version) if out.GetVersion() != expect.GetVersion() {
t.Errorf("Expected version to be %q, got %q", expect.GetVersion(), out.GetVersion())
} }
if out.Collection != expect.Collection { if out.Collection != expect.Collection {
t.Errorf("Expected collection to be %q, got %q", expect.Collection, out.Collection) t.Errorf("Expected collection to be %q, got %q", expect.Collection, out.Collection)
} }
svalue := out.String()
if svalue != in {
t.Errorf("Expected string value to be %q, got %q", in, svalue)
}
} }
} }

@ -0,0 +1,237 @@
/*
Copyright 2015 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 registry
import (
"github.com/google/go-github/github"
"github.com/kubernetes/deployment-manager/common"
"github.com/kubernetes/deployment-manager/util"
"fmt"
"net/url"
"regexp"
"strings"
"sync"
)
// RegistryProvider returns factories for creating registry clients.
type RegistryProvider interface {
GetRegistryByShortURL(URL string) (Registry, error)
GetRegistryByName(registryName string) (Registry, error)
GetGithubRegistry(cr common.Registry) (GithubRegistry, error)
}
func NewDefaultRegistryProvider() RegistryProvider {
registries := make(map[string]Registry)
rs := NewInmemRegistryService()
return &DefaultRegistryProvider{registries: registries, rs: rs}
}
type DefaultRegistryProvider struct {
sync.RWMutex
registries map[string]Registry
rs common.RegistryService
}
// Deprecated: Use GetRegistryByShortURL instead.
func (drp DefaultRegistryProvider) GetRegistryByURL(URL string) (Registry, error) {
return drp.GetRegistryByShortURL(URL)
}
func (drp DefaultRegistryProvider) GetRegistryByShortURL(URL string) (Registry, error) {
drp.RLock()
defer drp.RUnlock()
r := drp.findRegistryByShortURL(URL)
if r == nil {
cr, err := drp.rs.GetByURL(URL)
if err != nil {
return nil, err
}
r, err := drp.GetGithubRegistry(*cr)
if err != nil {
return nil, err
}
drp.registries[r.GetRegistryName()] = r
}
return r, nil
}
func (drp DefaultRegistryProvider) findRegistryByShortURL(URL string) Registry {
for _, r := range drp.registries {
if strings.HasPrefix(URL, r.GetRegistryShortURL()) {
return r
}
}
return nil
}
func (drp DefaultRegistryProvider) GetRegistryByName(registryName string) (Registry, error) {
drp.RLock()
defer drp.RUnlock()
r, ok := drp.registries[registryName]
if !ok {
cr, err := drp.rs.Get(registryName)
if err != nil {
return nil, err
}
r, err := drp.GetGithubRegistry(*cr)
if err != nil {
return nil, err
}
drp.registries[r.GetRegistryName()] = r
}
return r, nil
}
func ParseRegistryFormat(rf common.RegistryFormat) map[common.RegistryFormat]bool {
split := strings.Split(string(rf), ";")
var result map[common.RegistryFormat]bool
for _, format := range split {
result[common.RegistryFormat(format)] = true
}
return result
}
func (drp DefaultRegistryProvider) GetGithubRegistry(cr common.Registry) (GithubRegistry, error) {
if cr.Type == common.GithubRegistryType {
fMap := ParseRegistryFormat(cr.Format)
if fMap[common.UnversionedRegistry] && fMap[common.OneLevelRegistry] {
return NewGithubPackageRegistry(cr.Name, cr.URL, github.NewClient(nil))
}
if fMap[common.VersionedRegistry] && fMap[common.CollectionRegistry] {
return NewGithubTemplateRegistry(cr.Name, cr.URL, github.NewClient(nil))
}
return nil, fmt.Errorf("unknown registry format: %s", cr.Format)
}
return nil, fmt.Errorf("unknown registry type: %s", cr.Type)
}
// RE for a registry type that does support versions and has collections.
var TemplateRegistryMatcher = regexp.MustCompile("github.com/(.*)/(.*)/(.*)/(.*):(.*)")
// RE for a registry type that does not support versions and does not have collections.
var PackageRegistryMatcher = regexp.MustCompile("github.com/(.*)/(.*)/(.*)")
// IsGithubShortType returns whether a given type is a type description in a short format to a github repository type.
// For now, this means using github types:
// github.com/owner/repo/qualifier/type:version
// for example:
// github.com/kubernetes/application-dm-templates/storage/redis:v1
func IsGithubShortType(t string) bool {
return TemplateRegistryMatcher.MatchString(t)
}
// IsGithubShortPackageType returns whether a given type is a type description in a short format to a github
// package repository type.
// For now, this means using github types:
// github.com/owner/repo/type
// for example:
// github.com/helm/charts/cassandra
func IsGithubShortPackageType(t string) bool {
return PackageRegistryMatcher.MatchString(t)
}
// GetDownloadURLs checks a type to see if it is either a short git hub url or a fully specified URL
// and returns the URLs that should be used to fetch it. If the url is not fetchable (primitive type
// for example), it returns an empty slice.
func GetDownloadURLs(rp RegistryProvider, t string) ([]string, error) {
if IsGithubShortType(t) {
return ShortTypeToDownloadURLs(rp, t)
} else if IsGithubShortPackageType(t) {
return ShortTypeToPackageDownloadURLs(rp, t)
} else if util.IsHttpUrl(t) {
result, err := url.Parse(t)
if err != nil {
return nil, fmt.Errorf("cannot parse download URL %s: %s", t, err)
}
return []string{result.String()}, nil
}
return []string{}, nil
}
// ShortTypeToDownloadURLs converts a github URL into downloadable URL from github.
// Input must be of the type and is assumed to have been validated before this call:
// github.com/owner/repo/qualifier/type:version
// for example:
// github.com/kubernetes/application-dm-templates/storage/redis:v1
func ShortTypeToDownloadURLs(rp RegistryProvider, t string) ([]string, error) {
m := TemplateRegistryMatcher.FindStringSubmatch(t)
if len(m) != 6 {
return nil, fmt.Errorf("cannot parse short github url: %s", t)
}
r, err := rp.GetRegistryByShortURL(t)
if err != nil {
return nil, err
}
tt, err := NewType(m[3], m[4], m[5])
if err != nil {
return nil, err
}
urls, err := r.GetDownloadURLs(tt)
if err != nil {
return nil, err
}
return util.ConvertURLsToStrings(urls), err
}
// ShortTypeToPackageDownloadURLs converts a github URL into downloadable URLs from github.
// Input must be of the type and is assumed to have been validated before this call:
// github.com/owner/repo/type
// for example:
// github.com/helm/charts/cassandra
func ShortTypeToPackageDownloadURLs(rp RegistryProvider, t string) ([]string, error) {
m := PackageRegistryMatcher.FindStringSubmatch(t)
if len(m) != 4 {
return nil, fmt.Errorf("Failed to parse short github url: %s", t)
}
r, err := rp.GetRegistryByShortURL(t)
if err != nil {
return nil, err
}
tt, err := NewType("", m[3], "")
if err != nil {
return nil, err
}
urls, err := r.GetDownloadURLs(tt)
if err != nil {
return nil, err
}
return util.ConvertURLsToStrings(urls), err
}

@ -0,0 +1,140 @@
/*
Copyright 2015 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 registry
// TODO(jackgr): Finish implementing registry provider tests.
import (
"github.com/kubernetes/deployment-manager/common"
"fmt"
"net/url"
"regexp"
"strings"
"testing"
)
type urlAndError struct {
u string
e error
}
type testRegistryProvider struct {
URLPrefix string
r map[string]Registry
}
func newTestRegistryProvider(URLPrefix string, tests map[Type]urlAndError) RegistryProvider {
r := make(map[string]Registry)
r[URLPrefix] = testGithubRegistry{tests}
return testRegistryProvider{URLPrefix, r}
}
func (trp testRegistryProvider) GetRegistryByShortURL(URL string) (Registry, error) {
for key, r := range trp.r {
if strings.HasPrefix(URL, key) {
return r, nil
}
}
return nil, fmt.Errorf("No registry found for %s", URL)
}
func (trp testRegistryProvider) GetRegistryByName(registryName string) (Registry, error) {
panic(fmt.Errorf("GetRegistryByName should not be called in the test"))
}
func (trp testRegistryProvider) GetGithubRegistry(cr common.Registry) (GithubRegistry, error) {
panic(fmt.Errorf("GetGithubRegistry should not be called in the test"))
}
type testGithubRegistry struct {
responses map[Type]urlAndError
}
func (tgr testGithubRegistry) GetRegistryName() string {
panic(fmt.Errorf("GetRegistryName should not be called in the test"))
}
func (tgr testGithubRegistry) GetRegistryType() common.RegistryType {
return common.GithubRegistryType
}
func (tgr testGithubRegistry) GetRegistryShortURL() string {
panic(fmt.Errorf("GetRegistryShortURL should not be called in the test"))
}
func (tgr testGithubRegistry) GetRegistryFormat() common.RegistryFormat {
panic(fmt.Errorf("GetRegistryFormat should not be called in the test"))
}
func (tgr testGithubRegistry) GetDownloadURLs(t Type) ([]*url.URL, error) {
ret := tgr.responses[t]
URL, err := url.Parse(ret.u)
if err != nil {
panic(err)
}
return []*url.URL{URL}, ret.e
}
func (tgr testGithubRegistry) ListTypes(regex *regexp.Regexp) ([]Type, error) {
panic(fmt.Errorf("ListTypes should not be called in the test"))
}
func testUrlConversionDriver(rp RegistryProvider, tests map[string]urlAndError, t *testing.T) {
for in, expected := range tests {
actual, err := GetDownloadURLs(rp, in)
if err != expected.e {
t.Errorf("failed on: %s : expected error %v but got %v", in, expected.e, err)
}
if actual[0] != expected.u {
t.Errorf("failed on: %s : expected %s but got %v", in, expected.u, actual)
}
}
}
func TestShortGithubUrlMapping(t *testing.T) {
githubUrlMaps := map[Type]urlAndError{
NewTypeOrDie("common", "replicatedservice", "v1"): urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/common/replicatedservice/v1/replicatedservice.py", nil},
NewTypeOrDie("storage", "redis", "v1"): urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/storage/redis/v1/redis.jinja", nil},
}
tests := map[string]urlAndError{
"github.com/kubernetes/application-dm-templates/common/replicatedservice:v1": urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/common/replicatedservice/v1/replicatedservice.py", nil},
"github.com/kubernetes/application-dm-templates/storage/redis:v1": urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/storage/redis/v1/redis.jinja", nil},
}
test := newTestRegistryProvider("github.com/kubernetes/application-dm-templates", githubUrlMaps)
testUrlConversionDriver(test, tests, t)
}
func TestShortGithubUrlMappingDifferentOwnerAndRepo(t *testing.T) {
githubUrlMaps := map[Type]urlAndError{
NewTypeOrDie("common", "replicatedservice", "v1"): urlAndError{"https://raw.githubusercontent.com/example/mytemplates/master/common/replicatedservice/v1/replicatedservice.py", nil},
NewTypeOrDie("storage", "redis", "v1"): urlAndError{"https://raw.githubusercontent.com/example/mytemplates/master/storage/redis/v1/redis.jinja", nil},
}
tests := map[string]urlAndError{
"github.com/example/mytemplates/common/replicatedservice:v1": urlAndError{"https://raw.githubusercontent.com/example/mytemplates/master/common/replicatedservice/v1/replicatedservice.py", nil},
"github.com/example/mytemplates/storage/redis:v1": urlAndError{"https://raw.githubusercontent.com/example/mytemplates/master/storage/redis/v1/redis.jinja", nil},
}
test := newTestRegistryProvider("github.com/example/mytemplates", githubUrlMaps)
testUrlConversionDriver(test, tests, t)
}

@ -28,45 +28,54 @@ type SemVer struct {
Patch uint Patch uint
} }
func NewSemVer(version string) (*SemVer, error) { func ParseSemVer(version string) (SemVer, error) {
result := &SemVer{} var err error
parts := strings.SplitN(version, ".", 3) major, minor, patch := uint64(0), uint64(0), uint64(0)
if len(parts) > 3 { if len(version) > 0 {
return nil, fmt.Errorf("invalid semantic version: %s", version) parts := strings.SplitN(version, ".", 3)
} if len(parts) > 3 {
return SemVer{}, fmt.Errorf("invalid semantic version: %s", version)
}
major, err := strconv.ParseUint(parts[0], 10, 0) if len(parts) < 1 {
if err != nil { return SemVer{}, fmt.Errorf("invalid semantic version: %s", version)
return nil, fmt.Errorf("invalid semantic version: %s", version) }
}
result.Major = uint(major) if parts[0] != "0" {
if len(parts) < 3 { major, err = strconv.ParseUint(parts[0], 10, 0)
if len(parts) < 2 {
if len(parts) < 1 {
return nil, fmt.Errorf("invalid semantic version: %s", version)
}
} else {
minor, err := strconv.ParseUint(parts[1], 10, 0)
if err != nil { if err != nil {
return nil, fmt.Errorf("invalid semantic version: %s", version) return SemVer{}, fmt.Errorf("invalid semantic version: %s", version)
} }
result.Minor = uint(minor)
}
} else {
patch, err := strconv.ParseUint(parts[2], 10, 0)
if err != nil {
return nil, fmt.Errorf("invalid semantic version: %s", version)
} }
result.Patch = uint(patch) if len(parts) > 1 {
if parts[1] != "0" {
minor, err = strconv.ParseUint(parts[1], 10, 0)
if err != nil {
return SemVer{}, fmt.Errorf("invalid semantic version: %s", version)
}
}
if len(parts) > 2 {
if parts[2] != "0" {
patch, err = strconv.ParseUint(parts[2], 10, 0)
if err != nil {
return SemVer{}, fmt.Errorf("invalid semantic version: %s", version)
}
}
}
}
} }
return result, nil return SemVer{Major: uint(major), Minor: uint(minor), Patch: uint(patch)}, nil
}
func (s SemVer) IsZero() bool {
return s.Major == 0 && s.Minor == 0 && s.Patch == 0
} }
func (s *SemVer) String() string { // SemVer conforms to the Stringer interface.
func (s SemVer) String() string {
result := strconv.Itoa(int(s.Major)) result := strconv.Itoa(int(s.Major))
if s.Minor != 0 || s.Patch != 0 { if s.Minor != 0 || s.Patch != 0 {
result = result + "." + strconv.Itoa(int(s.Minor)) result = result + "." + strconv.Itoa(int(s.Minor))

@ -0,0 +1,91 @@
/*
Copyright 2015 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 registry
import (
"testing"
)
func TestParseInvalidVersionFails(t *testing.T) {
for _, test := range []string{
".",
"..",
"...",
"1.2.3.4",
"notAUnit",
"1.notAUint",
"1.1.notAUint",
"-1",
"1.-1",
"1.1.-1",
"1,1",
"1.1,1",
} {
_, err := ParseSemVer(test)
if err == nil {
t.Errorf("Invalid version parsed successfully: %s\n", test)
}
}
}
func TestParseValidVersionSucceeds(t *testing.T) {
for _, test := range []struct {
String string
Version SemVer
}{
{"", SemVer{0, 0, 0}},
{"0", SemVer{0, 0, 0}},
{"0.0", SemVer{0, 0, 0}},
{"0.0.0", SemVer{0, 0, 0}},
{"1", SemVer{1, 0, 0}},
{"1.0", SemVer{1, 0, 0}},
{"1.0.0", SemVer{1, 0, 0}},
{"1.1", SemVer{1, 1, 0}},
{"1.1.0", SemVer{1, 1, 0}},
{"1.1.1", SemVer{1, 1, 1}},
} {
result, err := ParseSemVer(test.String)
if err != nil {
t.Errorf("Valid version %s did not parse successfully\n", test.String)
}
if result.Major != test.Version.Major ||
result.Minor != test.Version.Minor ||
result.Patch != test.Version.Patch {
t.Errorf("Valid version %s did not parse correctly: %s\n", test.String, test.Version)
}
}
}
func TestConvertSemVerToStringSucceeds(t *testing.T) {
for _, test := range []struct {
String string
Version SemVer
}{
{"0", SemVer{0, 0, 0}},
{"0.1", SemVer{0, 1, 0}},
{"0.0.1", SemVer{0, 0, 1}},
{"1", SemVer{1, 0, 0}},
{"1.1", SemVer{1, 1, 0}},
{"1.1.1", SemVer{1, 1, 1}},
} {
result := test.Version.String()
if result != test.String {
t.Errorf("Valid version %s did not format correctly: %s\n", test.Version, test.String)
}
}
}

@ -6,7 +6,7 @@ you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -238,14 +238,14 @@ func getConfigurator() *configurator.Configurator {
func getPathVariable(w http.ResponseWriter, r *http.Request, variable, handler string) (string, error) { func getPathVariable(w http.ResponseWriter, r *http.Request, variable, handler string) (string, error) {
vars := mux.Vars(r) vars := mux.Vars(r)
variable, ok := vars[variable] escaped, ok := vars[variable]
if !ok { if !ok {
e := errors.New(fmt.Sprintf("%s name not found in URL", variable)) e := errors.New(fmt.Sprintf("%s name not found in URL", variable))
util.LogAndReturnError(handler, http.StatusBadRequest, e, w) util.LogAndReturnError(handler, http.StatusBadRequest, e, w)
return "", e return "", e
} }
unescaped, err := url.QueryUnescape(variable) unescaped, err := url.QueryUnescape(escaped)
if err != nil { if err != nil {
e := fmt.Errorf("cannot decode name (%v)", variable) e := fmt.Errorf("cannot decode name (%v)", variable)
util.LogAndReturnError(handler, http.StatusBadRequest, e, w) util.LogAndReturnError(handler, http.StatusBadRequest, e, w)

@ -6,7 +6,7 @@ you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -29,6 +29,26 @@ import (
"github.com/ghodss/yaml" "github.com/ghodss/yaml"
) )
// ConvertURLsToStrings converts a slice of *url.URL to a slice of string.
func ConvertURLsToStrings(urls []*url.URL) []string {
var result []string
for _, u := range urls {
result = append(result, u.String())
}
return result
}
// TrimURLScheme removes the scheme, if any, from an URL.
func TrimURLScheme(URL string) string {
parts := strings.SplitAfter(URL, "://")
if len(parts) > 1 {
return parts[1]
}
return URL
}
// A HandlerTester is a function that takes an HTTP method, an URL path, and a // A HandlerTester is a function that takes an HTTP method, an URL path, and a
// reader for a request body, creates a request from them, and serves it to the // reader for a request body, creates a request from them, and serves it to the
// handler to which it was bound and returns a response recorder describing the // handler to which it was bound and returns a response recorder describing the

@ -1,57 +0,0 @@
/*
Copyright 2015 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 util
import (
"regexp"
"github.com/kubernetes/deployment-manager/common"
)
var TemplateRegistryMatcher = regexp.MustCompile("github.com/(.*)/(.*)/(.*)/(.*):(.*)")
// RE for Registry that does not support versions and can have multiple files without imports.
var PackageRegistryMatcher = regexp.MustCompile("github.com/(.*)/(.*)/(.*)")
// IsTemplate returns whether a given type is a template.
func IsTemplate(t string, imports []*common.ImportFile) bool {
for _, imp := range imports {
if imp.Name == t {
return true
}
}
return false
}
// IsGithubShortType returns whether a given type is a type description in a short format to a github repository type.
// For now, this means using github types:
// github.com/owner/repo/qualifier/type:version
// for example:
// github.com/kubernetes/application-dm-templates/storage/redis:v1
func IsGithubShortType(t string) bool {
return TemplateRegistryMatcher.MatchString(t)
}
// IsGithubShortPackageType returns whether a given type is a type description in a short format to a github
// package repository type.
// For now, this means using github types:
// github.com/owner/repo/type
// for example:
// github.com/helm/charts/cassandra
func IsGithubShortPackageType(t string) bool {
return PackageRegistryMatcher.MatchString(t)
}
Loading…
Cancel
Save