diff --git a/common/types.go b/common/types.go index 0bdda9e7a..fc6a3a909 100644 --- a/common/types.go +++ b/common/types.go @@ -178,12 +178,21 @@ type RegistryCredential struct { 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 { - Name string `json:"name,omitempty"` // Friendly name for the repo - 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 + Name string `json:"name,omitempty"` // Friendly name for the registry + Type RegistryType `json:"type,omitempty"` // Technology implementing the registry + 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"` - Format RegistryFormat `json:"format,omitempty"` } // RegistryType defines the technology that implements the registry @@ -193,10 +202,35 @@ const ( 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 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" + + // 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) +} diff --git a/dm/dm.go b/dm/dm.go index 95f48ffd0..677e8e9bc 100644 --- a/dm/dm.go +++ b/dm/dm.go @@ -22,7 +22,6 @@ import ( "github.com/kubernetes/deployment-manager/common" "github.com/kubernetes/deployment-manager/expandybird/expander" "github.com/kubernetes/deployment-manager/registry" - "github.com/kubernetes/deployment-manager/util" "archive/tar" "bytes" @@ -35,6 +34,7 @@ import ( "net/http" "net/url" "os" + "path" "strconv" "strings" "time" @@ -81,8 +81,15 @@ var usage = func() { panic("\n") } -func getGitRegistry() (registry.Registry, error) { - return registry.NewDefaultRegistryProvider().GetRegistryByURL(*template_registry) +var provider = registry.NewDefaultRegistryProvider() + +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() { @@ -107,30 +114,21 @@ func execute() { switch args[0] { case "templates": - git, err := getGitRegistry() + git := getGithubRegistry() + types, err := git.ListTypes(nil) if err != nil { - panic(fmt.Errorf("Cannot get registry %v", err)) - } - templates, err := git.List() - if err != nil { - panic(fmt.Errorf("Cannot list %v", err)) + panic(fmt.Errorf("cannot list types in registry %s: %s", *template_registry, err)) } fmt.Printf("Templates:\n") - for _, t := range templates { - var typeSpec = "" - if len(t.Collection) > 0 { - typeSpec = t.Collection + "/" - } - typeSpec = typeSpec + t.Name - if len(t.Version) > 0 { - typeSpec = typeSpec + ":" + t.Version + for _, t := range types { + fmt.Printf("%s\n", t.String()) + urls, err := git.GetDownloadURLs(t) + if err != nil { + panic(fmt.Errorf("cannot get download urls for %s: %s", t, err)) } - fmt.Printf("%s\n", typeSpec) - fmt.Printf("\tshort URL: github.com/%s/%s\n", *template_registry, typeSpec) - fmt.Printf("\tdownload URL(s):\n") - for _, downloadURL := range getDownloadURLs(t) { + for _, downloadURL := range urls { fmt.Printf("\t%s\n", downloadURL) } } @@ -197,7 +195,7 @@ func execute() { usage() } - tUrls := getTypeURLs(args[1]) + tUrls := getDownloadURLs(args[1]) var tUrl = "" if len(tUrls) == 0 { // Type is most likely a primitive. @@ -268,46 +266,24 @@ func describeType(args []string) { usage() } - tUrls := getTypeURLs(args[1]) + tUrls := getDownloadURLs(args[1]) if len(tUrls) == 0 { panic(fmt.Errorf("Invalid type name, must be a template URL or in the form \":\": %s", args[1])) } + schemaUrl := tUrls[0] + ".schema" fmt.Println(callHttp(schemaUrl, "GET", "get schema for type ("+tUrls[0]+")", nil)) } -// getTypeURLs returns URLs or empty list if a primitive type. -func getTypeURLs(tName string) []string { - if util.IsHttpUrl(tName) { - // User can pass raw URL to template. - 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) +// getDownloadURLs returns URLs or empty list if a primitive type. +func getDownloadURLs(tName string) []string { + qName := path.Join(*template_registry, tName) + result, err := registry.GetDownloadURLs(provider, qName) 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 -} - -func isHttp(t string) bool { - return strings.HasPrefix(t, "http://") || strings.HasPrefix(t, "https://") + return result } func loadTemplate(args []string) *common.Template { @@ -343,8 +319,8 @@ func loadTemplate(args []string) *common.Template { } } else { if len(args) < 3 { - if t := getRegistryType(args[1]); t != nil { - template = buildTemplateFromType(*t) + if t, err := registry.ParseType(args[1]); err == nil { + template = buildTemplateFromType(t) } else { template, err = expander.NewTemplateFromRootTemplate(args[1]) } @@ -365,28 +341,6 @@ func loadTemplate(args []string) *common.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 ®istry.Type{ - Name: tList[0], - Version: tList[1], - } - } else { - return ®istry.Type{ - Collection: cList[0], - Name: cList[1], - Version: tList[1], - } - } -} - func buildTemplateFromType(t registry.Type) *common.Template { props := make(map[string]interface{}) if *properties != "" { @@ -409,11 +363,11 @@ func buildTemplateFromType(t registry.Type) *common.Template { } // 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{ Name: name, - Type: getDownloadURLs(t)[0], + Type: getDownloadURLs(t.String())[0], Properties: props, }}} diff --git a/manager/deployments.go b/manager/deployments.go index 1d728c829..bc2cf1563 100644 --- a/manager/deployments.go +++ b/manager/deployments.go @@ -18,6 +18,7 @@ package main import ( "encoding/json" + "errors" "flag" "fmt" "io" @@ -25,7 +26,9 @@ import ( "log" "net" "net/http" + "net/url" "os" + "regexp" "strings" "github.com/ghodss/yaml" @@ -51,8 +54,8 @@ var deployments = []Route{ {"ListTypeInstances", "/types/{type}/instances", "GET", listTypeInstancesHandlerFunc, ""}, {"ListRegistries", "/registries", "GET", listRegistriesHandlerFunc, ""}, {"GetRegistry", "/registries/{registry}", "GET", getRegistryHandlerFunc, ""}, - {"ListCharts", "/registries/{registry}/charts", "GET", listChartsHandlerFunc, ""}, - {"GetChart", "/registries/{registry}/charts/{chart}", "GET", getChartHandlerFunc, ""}, + {"ListRegistryTypes", "/registries/{registry}/types", "GET", listRegistryTypesHandlerFunc, ""}, + {"GetDownloadURLs", "/registries/{registry}/types/{type}", "GET", getDownloadURLsHandlerFunc, ""}, } 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) { vars := mux.Vars(r) - ret, ok := vars[variable] + escaped, ok := vars[variable] 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) 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 { @@ -368,37 +379,53 @@ func getRegistryHandlerFunc(w http.ResponseWriter, r *http.Request) { util.LogHandlerExitWithJSON(handler, w, cr, http.StatusOK) } -func listChartsHandlerFunc(w http.ResponseWriter, r *http.Request) { - handler := "manager: list charts" +func listRegistryTypesHandlerFunc(w http.ResponseWriter, r *http.Request) { + handler := "manager: list registry types" util.LogHandlerEntry(handler, r) registryName, err := getPathVariable(w, r, "registry", handler) if err != nil { 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 { util.LogAndReturnError(handler, http.StatusInternalServerError, err, w) return } - util.LogHandlerExitWithJSON(handler, w, chartNames, http.StatusOK) + util.LogHandlerExitWithJSON(handler, w, registryTypes, http.StatusOK) } -func getChartHandlerFunc(w http.ResponseWriter, r *http.Request) { - handler := "manager: get chart" +func getDownloadURLsHandlerFunc(w http.ResponseWriter, r *http.Request) { + handler := "manager: get download URLs" util.LogHandlerEntry(handler, r) registryName, err := getPathVariable(w, r, "registry", handler) if err != nil { 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 { + util.LogAndReturnError(handler, http.StatusInternalServerError, err, w) return } - c, err := backend.GetChart(registryName, chartName) + c, err := backend.GetDownloadURLs(registryName, tt) if err != nil { util.LogAndReturnError(handler, http.StatusBadRequest, err, w) return diff --git a/manager/manager/expander.go b/manager/manager/expander.go index 95875ea14..49557ac39 100644 --- a/manager/manager/expander.go +++ b/manager/manager/expander.go @@ -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 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. @@ -25,7 +25,6 @@ import ( "github.com/ghodss/yaml" "github.com/kubernetes/deployment-manager/common" - "github.com/kubernetes/deployment-manager/util" ) const ( @@ -101,7 +100,7 @@ func walkLayout(l *common.Layout, imports []*common.ImportFile, toReplace map[st for len(toVisit) > 0 { lr := toVisit[0] 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 } else if toReplace[nodeKey] != nil { toReplace[nodeKey].Resources = lr.Resources @@ -113,6 +112,17 @@ func walkLayout(l *common.Layout, imports []*common.ImportFile, toReplace map[st 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. // It will also update the imports in the provided template if any were added // during type resolution. diff --git a/manager/manager/manager.go b/manager/manager/manager.go index a8ecee6c3..6ea47c19e 100644 --- a/manager/manager/manager.go +++ b/manager/manager/manager.go @@ -19,6 +19,8 @@ package manager import ( "fmt" "log" + "net/url" + "regexp" "time" "github.com/kubernetes/deployment-manager/common" @@ -50,9 +52,9 @@ type Manager interface { GetRegistry(name string) (*common.Registry, error) DeleteRegistry(name string) error - // Charts - ListCharts(registryName string) ([]string, error) - GetChart(registryName, chartName string) (*registry.Chart, error) + // Registry Types + ListRegistryTypes(registryName string, regex *regexp.Regexp) ([]registry.Type, error) + GetDownloadURLs(registryName string, t registry.Type) ([]*url.URL, error) } type manager struct { @@ -60,7 +62,7 @@ type manager struct { deployer Deployer repository repository.Repository provider registry.RegistryProvider - service registry.RegistryService + service common.RegistryService } // NewManager returns a new initialized Manager. @@ -68,7 +70,7 @@ func NewManager(expander Expander, deployer Deployer, repository repository.Repository, provider registry.RegistryProvider, - service registry.RegistryService) Manager { + service common.RegistryService) Manager { return &manager{expander, deployer, repository, provider, service} } @@ -363,22 +365,25 @@ func getResourceErrors(c *common.Configuration) []string { return errs } -// ListCharts retrieves the names of the charts in a given registry. -func (m *manager) ListCharts(registryName string) ([]string, error) { +// ListRegistryTypes lists types in a given registry whose string values +// 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) if err != nil { return nil, err } - return r.ListCharts() + return r.ListTypes(regex) } -// GetChart retrieves a given chart in a given registry. -func (m *manager) GetChart(registryName, chartName string) (*registry.Chart, error) { +// GetDownloadURLs returns the URLs required to download the contents +// 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) if err != nil { return nil, err } - return r.GetChart(chartName) + return r.GetDownloadURLs(t) } diff --git a/manager/manager/manager_test.go b/manager/manager/manager_test.go index 3cfb68891..9d80a438c 100644 --- a/manager/manager/manager_test.go +++ b/manager/manager/manager_test.go @@ -230,121 +230,31 @@ func (repository *repositoryStub) GetManifest(d string, m string) (*common.Manif return nil, errTest } -func (r *repositoryStub) ListTypes() []string { - r.ListTypesCalled = true +func (tgr *repositoryStub) ListTypes() []string { + tgr.ListTypesCalled = true return []string{} } -func (r *repositoryStub) GetTypeInstances(t string) []*common.TypeInstance { - r.GetTypeInstancesCalled = true +func (tgr *repositoryStub) GetTypeInstances(t string) []*common.TypeInstance { + tgr.GetTypeInstancesCalled = true return []*common.TypeInstance{} } -func (r *repositoryStub) ClearTypeInstances(d string) { - r.TypeInstancesCleared = true +func (tgr *repositoryStub) ClearTypeInstances(d string) { + 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 { - 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 := ®istryStub{} - 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 := ®istryProviderStub{} - 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 testRepository = newRepositoryStub() var testDeployer = newDeployerStub() var testRegistryService = registry.NewInmemRegistryService() -var testProvider = newRegistryProviderStub() +var testProvider = newTestRegistryProvider("", nil) var testManager = NewManager(testExpander, testDeployer, testRepository, testProvider, testRegistryService) func TestListDeployments(t *testing.T) { @@ -615,3 +525,23 @@ func TestListInstances(t *testing.T) { 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) + } + */ +} diff --git a/manager/manager/registryprovider_test.go b/manager/manager/registryprovider_test.go new file mode 100644 index 000000000..4a4cab423 --- /dev/null +++ b/manager/manager/registryprovider_test.go @@ -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 +} diff --git a/manager/manager/typeresolver.go b/manager/manager/typeresolver.go index 99b4b86fa..5869558c3 100644 --- a/manager/manager/typeresolver.go +++ b/manager/manager/typeresolver.go @@ -100,7 +100,7 @@ func (tr *typeResolver) ResolveTypes(config *common.Configuration, imports []*co toFetch := make([]*fetchUnit, 0, tr.maxUrls) 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). - urls, err := tr.MapFetchableURLs(r.Type) + urls, err := registry.GetDownloadURLs(tr.rp, r.Type) if err != nil { 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 { i := &common.ImportFile{Name: v.Name} var existingSchema string - urls, conversionErr := tr.MapFetchableURLs(v.Path) + urls, conversionErr := registry.GetDownloadURLs(tr.rp, v.Path) if conversionErr != nil { 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 } -// 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) { if len(templates) == 1 { return templates[0], nil diff --git a/manager/manager/typeresolver_test.go b/manager/manager/typeresolver_test.go index a2e1d4f85..321564c23 100644 --- a/manager/manager/typeresolver_test.go +++ b/manager/manager/typeresolver_test.go @@ -18,7 +18,6 @@ package manager import ( "errors" - "fmt" "net/http" "reflect" "strings" @@ -58,108 +57,6 @@ func (tg *testGetter) Get(url string) (body string, code int, err error) { 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) { g := &testGetter{test: t, responses: c.responses} r := &typeResolver{ @@ -376,40 +273,6 @@ func TestSharedImport(t *testing.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 = ` resources: - name: foo @@ -438,8 +301,8 @@ func TestShortGithubUrl(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{"common", "replicatedservice", "v2"}: urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/common/replicatedservice/v2/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.NewTypeOrDie("common", "replicatedservice", "v2"): urlAndError{"https://raw.githubusercontent.com/kubernetes/application-dm-templates/master/common/replicatedservice/v2/replicatedservice.py", nil}, } test := resolverTestCase{ @@ -447,7 +310,7 @@ func TestShortGithubUrl(t *testing.T) { importOut: finalImports, urlcount: 4, responses: responses, - registryProvider: newTestRegistryProvider("github.com/kubernetes/application-dm-templates", githubUrlMaps, 2), + registryProvider: newTestRegistryProvider("github.com/kubernetes/application-dm-templates", githubUrlMaps), } testDriver(test, t) } diff --git a/registry/github_package_registry.go b/registry/github_package_registry.go index 30fbdee04..681eeef18 100644 --- a/registry/github_package_registry.go +++ b/registry/github_package_registry.go @@ -20,12 +20,15 @@ import ( "github.com/google/go-github/github" "github.com/kubernetes/deployment-manager/common" + "fmt" "log" + "net/url" + "regexp" "strings" ) // 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: // package/ // Chart.yaml @@ -34,53 +37,23 @@ import ( // bar.yaml // ... type GithubPackageRegistry struct { - owner string - repository string - client *github.Client + githubRegistry } -// NewGithubRegistry creates a Registry that can be used to talk to github. -func NewGithubPackageRegistry(owner, repository string, client *github.Client) *GithubPackageRegistry { - return &GithubPackageRegistry{ - owner: owner, - repository: repository, - client: client, +// NewGithubPackageRegistry creates a GithubPackageRegistry. +func NewGithubPackageRegistry(name, shortURL string, client *github.Client) (GithubPackageRegistry, error) { + format := fmt.Sprintf("%s;%s", common.UnversionedRegistry, common.OneLevelRegistry) + gr, err := newGithubRegistry(name, shortURL, common.RegistryFormat(format), client) + if err != nil { + 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. -func (g *GithubPackageRegistry) ListCharts() ([]string, error) { - // TODO(jackgr): implement this method - return []string{}, nil + return GithubPackageRegistry{githubRegistry: gr}, nil } -// GetChart fetches the contents of a given chart. -func (g *GithubPackageRegistry) GetChart(chartName string) (*Chart, error) { - // TODO(jackgr): implement this method - return nil, nil -} - -// Deprecated: Use ListCharts, instead. -// List the types from the Registry. -func (g *GithubPackageRegistry) List() ([]Type, error) { +// 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 GithubPackageRegistry) ListTypes(regex *regexp.Regexp) ([]Type, error) { // Just list all the types at the top level. types, err := g.getDirs("") 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 } -// Deprecated: Use GetChart, instead. -// GetURLs fetches the download URLs for a given Type. -func (g *GithubPackageRegistry) GetURLs(t Type) ([]string, error) { +// GetDownloadURLs fetches the download URLs for a given Type. +func (g GithubPackageRegistry) GetDownloadURLs(t Type) ([]*url.URL, error) { path, err := g.MakeRepositoryPath(t) if err != nil { - return []string{}, err + return nil, err } + _, dc, _, err := g.client.Repositories.GetContents(g.owner, g.repository, path, nil) if err != nil { 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 { if *f.Type == "file" { 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 } -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) if err != nil { 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. // The returned repository path will be of the form: // Type.Name/manifests -func (g *GithubPackageRegistry) MakeRepositoryPath(t Type) (string, error) { +func (g GithubPackageRegistry) MakeRepositoryPath(t Type) (string, error) { // Construct the return path return t.Name + "/manifests", nil } diff --git a/registry/github_registry.go b/registry/github_registry.go index 970340faa..5f25aa1ae 100644 --- a/registry/github_registry.go +++ b/registry/github_registry.go @@ -19,110 +19,110 @@ package registry import ( "github.com/google/go-github/github" "github.com/kubernetes/deployment-manager/common" + "github.com/kubernetes/deployment-manager/util" "fmt" "log" + "net/url" + "regexp" "strings" ) -// GithubRegistry implements the Registry interface that talks to github and -// implements 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 GithubRegistry struct { +// githubRegistry implements the Registry interface and talks to github. +// The registry short URL and format determine how types are laid out in the +// registry. +type githubRegistry struct { + name string + shortURL string owner string repository string path string + format common.RegistryFormat client *github.Client } -// NewGithubRegistry creates a Registry that can be used to talk to github. -func NewGithubRegistry(owner, repository, path string, client *github.Client) *GithubRegistry { - return &GithubRegistry{ +// newGithubRegistry creates a githubRegistry. +func newGithubRegistry(name, shortURL string, format common.RegistryFormat, client *github.Client) (githubRegistry, error) { + 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, repository: repository, path: path, + format: format, 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 -func (g *GithubRegistry) GetRegistryName() string { - // TODO(jackgr): implement this method - return "" +func (g githubRegistry) GetRegistryName() string { + return g.name } // GetRegistryType returns the type of this registry. -func (g *GithubRegistry) GetRegistryType() common.RegistryType { - // TODO(jackgr): implement this method +func (g githubRegistry) GetRegistryType() common.RegistryType { return common.GithubRegistryType } -// GetRegistryURL returns the URL for this registry. -func (g *GithubRegistry) GetRegistryURL() string { - // TODO(jackgr): implement this method - return "" +// GetRegistryShortURL returns the short URL for this registry. +func (g githubRegistry) GetRegistryShortURL() string { + return g.shortURL } -// ListCharts lists the versioned chart names in this registry. -func (g *GithubRegistry) ListCharts() ([]string, error) { - var result []string - 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 - } +// GetRegistryFormat returns the format of this registry. +func (g githubRegistry) GetRegistryFormat() common.RegistryFormat { + return g.format +} - for _, version := range versions { - result = append(result, fmt.Sprintf("%s#%s", name, version)) - } - } +// GetRegistryOwner returns the owner name for this registry +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. -func (g *GithubRegistry) GetChart(chartName string) (*Chart, error) { - // TODO(jackgr): implement this method - return nil, nil +// GetRegistryName returns the name of this registry +func (g githubRegistry) GetRegistryPath() string { + return g.path } -// Deprecated: Use ListCharts, instead. -// List the types from the Registry. -func (g *GithubRegistry) List() ([]Type, error) { +// 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 githubRegistry) ListTypes(regex *regexp.Regexp) ([]Type, error) { // First list all the collections at the top level. collections, err := g.getDirs("") if err != nil { - log.Printf("Failed to list qualifiers: %v", err) + log.Printf("cannot list qualifiers: %v", 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) types, err := g.getDirs(c) 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 } for _, t := range types { + path := c + "/" + t // 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 { - log.Printf("Failed to fetch versions for template: %s", t) + log.Printf("cannot fetch versions at path %s", path) return nil, err } + 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 } -// Deprecated: Use GetChart, instead. -// GetURL fetches the download URL for a given Type and checks for existence of a schema file. -func (g *GithubRegistry) GetURLs(t Type) ([]string, error) { +// GetDownloadURLs fetches the download URLs for a given Type and checks for existence of a schema file. +func (g githubRegistry) GetDownloadURLs(t Type) ([]*url.URL, error) { path, err := g.MakeRepositoryPath(t) if err != nil { - return []string{}, err + return nil, err } _, dc, _, err := g.client.Repositories.GetContents(g.owner, g.repository, path, nil) if err != nil { - log.Printf("Failed to list versions at path: %s: %v", path, err) - return []string{}, err + 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" { @@ -175,16 +182,24 @@ func (g *GithubRegistry) GetURLs(t Type) ([]string, error) { } } } + 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 if dir != "" { path = g.path + "/" + dir @@ -206,7 +221,7 @@ func (g *GithubRegistry) getDirs(dir string) ([]string, error) { return dirs, nil } -func (g *GithubRegistry) mapCollection(collection string) (string, error) { +func (g githubRegistry) mapCollection(collection string) (string, error) { if strings.ContainsAny(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. // 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 // 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 collection, err := g.mapCollection(t.Collection) if err != nil { @@ -233,5 +248,5 @@ func (g *GithubRegistry) MakeRepositoryPath(t Type) (string, error) { if len(collection) > 0 { p += collection + "/" } - return p + t.Name + "/" + t.Version, nil + return p + t.Name + "/" + t.GetVersion(), nil } diff --git a/registry/github_template_registry.go b/registry/github_template_registry.go new file mode 100644 index 000000000..586e22118 --- /dev/null +++ b/registry/github_template_registry.go @@ -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 +} diff --git a/registry/inmem_registry_service.go b/registry/inmem_registry_service.go index 71de20818..8affeea14 100644 --- a/registry/inmem_registry_service.go +++ b/registry/inmem_registry_service.go @@ -27,21 +27,25 @@ type inmemRegistryService struct { registries map[string]*common.Registry } -func NewInmemRegistryService() RegistryService { +func NewInmemRegistryService() common.RegistryService { rs := &inmemRegistryService{ registries: make(map[string]*common.Registry), } + + pFormat := fmt.Sprintf("%s;%s", common.UnversionedRegistry, common.OneLevelRegistry) rs.Create(&common.Registry{ Name: "charts", Type: common.GithubRegistryType, 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{ Name: "application-dm-templates", Type: common.GithubRegistryType, URL: "github.com/kubernetes/application-dm-templates", - Format: common.VersionedRegistry, + Format: common.RegistryFormat(tFormat), }) return rs } diff --git a/registry/registry.go b/registry/registry.go index 44c037d4d..0f703f5e4 100644 --- a/registry/registry.go +++ b/registry/registry.go @@ -1,7 +1,7 @@ /* 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 obtain a copy of the License at @@ -17,11 +17,12 @@ limitations under the License. package registry import ( - "strings" - "github.com/kubernetes/deployment-manager/common" + "fmt" "net/url" + "regexp" + "strings" ) // Registry abstracts a registry that holds charts, which can be @@ -32,66 +33,110 @@ type Registry interface { GetRegistryName() string // GetRegistryType returns the type of this registry. GetRegistryType() common.RegistryType - // GetRegistryURL returns the URL for this registry. - GetRegistryURL() string - - // ListCharts lists the versioned chart names in this registry. - ListCharts() ([]string, error) - // GetChart fetches the contents of a given chart. - GetChart(chartName string) (*Chart, error) - - // Deprecated: Use ListCharts, instead. - List() ([]Type, error) - // Deprecated: Use GetChart, instead. - GetURLs(t Type) ([]string, error) + // GetRegistryShortURL returns the short URL for this registry. + GetRegistryShortURL() string + // GetRegistryFormat returns the format of this registry. + GetRegistryFormat() common.RegistryFormat + + // ListTypes lists types in this registry whose string values conform to the + // supplied regular expression, or all types, if the regular expression is nil. + ListTypes(regex *regexp.Regexp) ([]Type, error) + // GetDownloadURLs returns the URLs required to download the type contents. + GetDownloadURLs(t Type) ([]*url.URL, error) } -type RegistryService interface { - // List all the registries - List() ([]*common.Registry, error) - // Create a new registry - Create(registry *common.Registry) error - // Get a registry - Get(name string) (*common.Registry, error) - // Delete a registry - Delete(name string) error - // Find a registry that backs the given URL - GetByURL(URL string) (*common.Registry, error) +// GithubRegistry abstracts a registry that resides in a Github repository. +type GithubRegistry interface { + Registry // A GithubRegistry is a Registry. + // GetRegistryOwner returns the owner name for this registry + GetRegistryOwner() string + // GetRegistryRepository returns the repository name for this registry. + GetRegistryRepository() string + // GetRegistryPath returns the path to the registry in the repository. + GetRegistryPath() string } -// Deprecated: Use Chart, instead type Type struct { Collection string Name string - Version string + version SemVer } -// ParseType takes a registry name and parses it into a *registry.Type. -func ParseType(name string) *Type { - tt := &Type{} +// NewType initializes a type +func NewType(collection, name, version string) (Type, error) { + 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 { - 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], "/") - if len(cList) == 1 { tt.Name = tList[0] } else { tt.Collection = cList[0] 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? - Metadata map[string]interface{} + return tt, nil } diff --git a/registry/registry_provider.go b/registry/registry_provider.go deleted file mode 100644 index 9e97d62bc..000000000 --- a/registry/registry_provider.go +++ /dev/null @@ -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) -} diff --git a/registry/registry_test.go b/registry/registry_test.go index 9f9ce5e06..53bf60eda 100644 --- a/registry/registry_test.go +++ b/registry/registry_test.go @@ -4,25 +4,36 @@ import ( "testing" ) -func TestParseType(t *testing.T) { - // TODO: Are there some real-world examples we want to valide here? - tests := map[string]*Type{ - "foo": &Type{Name: "foo"}, - "foo:v1": &Type{Name: "foo", Version: "v1"}, - "github.com/foo": &Type{Name: "foo", Collection: "github.com"}, - "github.com/foo:v1.2.3": &Type{Name: "foo", Collection: "github.com", Version: "v1.2.3"}, +func TestTypeConversion(t *testing.T) { + // TODO: Are there some real-world examples we want to validate here? + tests := map[string]Type{ + "foo": NewTypeOrDie("", "foo", ""), + "foo:v1": NewTypeOrDie("", "foo", "v1"), + "github.com/foo": NewTypeOrDie("github.com", "foo", ""), + "github.com/foo:v1.2.3": NewTypeOrDie("github.com", "foo", "v1.2.3"), } 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 { 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 { 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) + } } } diff --git a/registry/registryprovider.go b/registry/registryprovider.go new file mode 100644 index 000000000..3675a9401 --- /dev/null +++ b/registry/registryprovider.go @@ -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 +} diff --git a/registry/registryprovider_test.go b/registry/registryprovider_test.go new file mode 100644 index 000000000..708975089 --- /dev/null +++ b/registry/registryprovider_test.go @@ -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) +} diff --git a/registry/semver.go b/registry/semver.go index f5c1ff596..f49fd833b 100644 --- a/registry/semver.go +++ b/registry/semver.go @@ -28,45 +28,54 @@ type SemVer struct { Patch uint } -func NewSemVer(version string) (*SemVer, error) { - result := &SemVer{} - parts := strings.SplitN(version, ".", 3) - if len(parts) > 3 { - return nil, fmt.Errorf("invalid semantic version: %s", version) - } +func ParseSemVer(version string) (SemVer, error) { + var err error + major, minor, patch := uint64(0), uint64(0), uint64(0) + if len(version) > 0 { + 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 err != nil { - return nil, fmt.Errorf("invalid semantic version: %s", version) - } + if len(parts) < 1 { + return SemVer{}, fmt.Errorf("invalid semantic version: %s", version) + } - result.Major = uint(major) - if len(parts) < 3 { - 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 parts[0] != "0" { + major, err = strconv.ParseUint(parts[0], 10, 0) 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)) if s.Minor != 0 || s.Patch != 0 { result = result + "." + strconv.Itoa(int(s.Minor)) diff --git a/registry/semver_test.go b/registry/semver_test.go new file mode 100644 index 000000000..b88c7455c --- /dev/null +++ b/registry/semver_test.go @@ -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) + } + } +} diff --git a/resourcifier/configurations.go b/resourcifier/configurations.go index 09842eb08..783f95f93 100644 --- a/resourcifier/configurations.go +++ b/resourcifier/configurations.go @@ -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 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. @@ -238,14 +238,14 @@ func getConfigurator() *configurator.Configurator { func getPathVariable(w http.ResponseWriter, r *http.Request, variable, handler string) (string, error) { vars := mux.Vars(r) - variable, ok := vars[variable] + escaped, ok := vars[variable] if !ok { e := errors.New(fmt.Sprintf("%s name not found in URL", variable)) util.LogAndReturnError(handler, http.StatusBadRequest, e, w) return "", e } - unescaped, err := url.QueryUnescape(variable) + unescaped, err := url.QueryUnescape(escaped) if err != nil { e := fmt.Errorf("cannot decode name (%v)", variable) util.LogAndReturnError(handler, http.StatusBadRequest, e, w) diff --git a/util/httputil.go b/util/httputil.go index 572f940b9..a7a21484e 100644 --- a/util/httputil.go +++ b/util/httputil.go @@ -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 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. @@ -29,6 +29,26 @@ import ( "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 // 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 diff --git a/util/templateutil.go b/util/templateutil.go deleted file mode 100644 index 3ce844c5d..000000000 --- a/util/templateutil.go +++ /dev/null @@ -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) -}