diff --git a/chart/chart.go b/chart/chart.go new file mode 100644 index 000000000..2f0a35c42 --- /dev/null +++ b/chart/chart.go @@ -0,0 +1,214 @@ +package chart + +import ( + "archive/tar" + "compress/gzip" + "errors" + "fmt" + "io" + "io/ioutil" + "os" + "path/filepath" + "strings" + + "github.com/kubernetes/deployment-manager/log" +) + +const ChartfileName string = "Chart.yaml" + +const ( + preTemplates string = "templates/" + preHooks string = "hooks/" + preDocs string = "docs/" +) + +// Chart represents a complete chart. +// +// A chart consists of the following parts: +// +// - Chart.yaml: In code, we refer to this as the Chartfile +// - templates/*: The template directory +// - README.md: Optional README file +// - LICENSE: Optional license file +// - hooks/: Optional hooks registry +// - docs/: Optional docs directory +// +// Packed charts are stored in gzipped tar archives (.tgz). Unpackaged charts +// are directories where the directory name is the Chartfile.Name. +// +// Optionally, a chart might also locate a provenance (.prov) file that it +// can use for cryptographic signing. +type Chart interface { + // Chartfile resturns a *Chartfile for this chart. + Chartfile() *Chartfile + // Dir returns a directory where the chart can be accessed. + Dir() string + + // Close cleans up a chart. + Close() error +} + +type dirChart struct { + chartfile *Chartfile + dir string +} + +func (d *dirChart) Chartfile() *Chartfile { + return d.chartfile +} + +func (d *dirChart) Dir() string { + return "." +} + +func (d *dirChart) Close() error { + return nil +} + +type tarChart struct { + chartfile *Chartfile + tmpDir string +} + +func (t *tarChart) Chartfile() *Chartfile { + return t.chartfile +} + +func (t *tarChart) Dir() string { + return "." +} + +func (t *tarChart) Close() error { + // Remove the temp directory. + return os.RemoveAll(t.tmpDir) +} + +// LoadDir loads an entire chart from a directory. +// +// This includes the Chart.yaml (*Chartfile) and all of the manifests. +// +// If you are just reading the Chart.yaml file, it is substantially more +// performant to use LoadChartfile. +func LoadDir(chart string) (Chart, error) { + if fi, err := os.Stat(chart); err != nil { + return nil, err + } else if !fi.IsDir() { + return nil, fmt.Errorf("Chart %s is not a directory.", chart) + } + + cf, err := LoadChartfile(filepath.Join(chart, "Chart.yaml")) + if err != nil { + return nil, err + } + + c := &dirChart{ + chartfile: cf, + dir: chart, + } + + return c, nil +} + +// Load loads a chart from a chart archive. +// +// A chart archive is a gzipped tar archive that follows the Chart format +// specification. +func Load(archive string) (Chart, error) { + if fi, err := os.Stat(archive); err != nil { + return nil, err + } else if fi.IsDir() { + return nil, errors.New("cannot load a directory with chart.Load()") + } + + raw, err := os.Open(archive) + if err != nil { + return nil, err + } + defer raw.Close() + + unzipped, err := gzip.NewReader(raw) + if err != nil { + return nil, err + } + defer unzipped.Close() + + untarred := tar.NewReader(unzipped) + c, err := loadTar(untarred) + if err != nil { + return c, err + } + + cf, err := LoadChartfile(filepath.Join(c.tmpDir, ChartfileName)) + if err != nil { + return c, err + } + c.chartfile = cf + return c, nil +} + +func loadTar(r *tar.Reader) (*tarChart, error) { + td, err := ioutil.TempDir("", "chart-") + if err != nil { + return nil, err + } + c := &tarChart{ + chartfile: &Chartfile{}, + tmpDir: td, + } + + firstDir := "" + + hdr, err := r.Next() + for err == nil { + log.Debug("Reading %s", hdr.Name) + + // This is to prevent malformed tar attacks. + hdr.Name = filepath.Clean(hdr.Name) + + if firstDir == "" { + fi := hdr.FileInfo() + if fi.IsDir() { + log.Debug("Discovered app named %s", hdr.Name) + firstDir = hdr.Name + } else { + log.Warn("Unexpected file at root of archive: %s", hdr.Name) + } + } else if strings.HasPrefix(hdr.Name, firstDir) { + log.Debug("Extracting %s to %s", hdr.Name, c.tmpDir) + + // We know this has the prefix, so we know there won't be an error. + rel, _ := filepath.Rel(firstDir, hdr.Name) + + // If tar record is a directory, create one in the tmpdir and return. + if hdr.FileInfo().IsDir() { + os.MkdirAll(filepath.Join(c.tmpDir, rel), 0755) + hdr, err = r.Next() + continue + } + + dest := filepath.Join(c.tmpDir, rel) + f, err := os.Create(filepath.Join(c.tmpDir, rel)) + if err != nil { + log.Warn("Could not create %s: %s", dest, err) + hdr, err = r.Next() + continue + } + if _, err := io.Copy(f, r); err != nil { + log.Warn("Failed to copy %s: %s", dest, err) + } + f.Close() + } else { + log.Warn("Unexpected file outside of chart: %s", hdr.Name) + } + hdr, err = r.Next() + } + + if err != nil && err != io.EOF { + log.Warn("Unexpected error reading tar: %s", err) + c.Close() + return c, err + } + log.Info("Reached end of Tar file") + + return c, nil +} diff --git a/chart/chart_test.go b/chart/chart_test.go new file mode 100644 index 000000000..5a16dc6bf --- /dev/null +++ b/chart/chart_test.go @@ -0,0 +1,74 @@ +package chart + +import ( + "testing" + + "github.com/kubernetes/deployment-manager/log" +) + +const ( + testfile = "testdata/frobnitz/Chart.yaml" + testdir = "testdata/frobnitz/" + testarchive = "testdata/frobnitz-0.0.1.tgz" + testill = "testdata/ill-1.2.3.tgz" + testnochart = "testdata/nochart.tgz" +) + +func init() { + log.IsDebugging = true +} + +func TestLoadDir(t *testing.T) { + c, err := LoadDir(testdir) + if err != nil { + t.Errorf("Failed to load chart: %s", err) + } + + if c.Chartfile().Name != "frobnitz" { + t.Errorf("Expected chart name to be 'frobnitz'. Got '%s'.", c.Chartfile().Name) + } + + if c.Chartfile().Dependencies[0].Version != "^3" { + d := c.Chartfile().Dependencies[0].Version + t.Errorf("Expected dependency 0 to have version '^3'. Got '%s'.", d) + } +} + +func TestLoad(t *testing.T) { + c, err := Load(testarchive) + if err != nil { + t.Errorf("Failed to load chart: %s", err) + return + } + defer c.Close() + + if c.Chartfile() == nil { + t.Error("No chartfile was loaded.") + return + } + + if c.Chartfile().Name != "frobnitz" { + t.Errorf("Expected name to be frobnitz, got %q", c.Chartfile().Name) + } +} + +func TestLoadIll(t *testing.T) { + c, err := Load(testill) + if err != nil { + t.Errorf("Failed to load chart: %s", err) + return + } + defer c.Close() + + if c.Chartfile() == nil { + t.Error("No chartfile was loaded.") + return + } +} + +func TestLoadNochart(t *testing.T) { + _, err := Load(testnochart) + if err == nil { + t.Error("Nochart should not have loaded at all.") + } +} diff --git a/chart/chartfile.go b/chart/chartfile.go new file mode 100644 index 000000000..821f941be --- /dev/null +++ b/chart/chartfile.go @@ -0,0 +1,79 @@ +package chart + +import ( + "io/ioutil" + + "github.com/Masterminds/semver" + "gopkg.in/yaml.v2" +) + +// Chartfile describes a Helm Chart (e.g. Chart.yaml) +type Chartfile struct { + Name string `yaml:"name"` + Description string `yaml:"description"` + Version string `yaml:"version"` + Keywords []string `yaml:"keywords,omitempty"` + Maintainers []*Maintainer `yaml:"maintainers,omitempty"` + Source []string `yaml:"source,omitempty"` + Home string `yaml:"home"` + Dependencies []*Dependency `yaml:"dependencies,omitempty"` + Environment []*EnvConstraint `yaml:"environment,omitempty"` +} + +// Maintainer describes a chart maintainer. +type Maintainer struct { + Name string `yaml:"name"` + Email string `yaml:"email,omitempty"` +} + +// Dependency describes a specific dependency. +type Dependency struct { + Name string `yaml:"name,omitempty"` + Version string `yaml:"version"` + Location string `yaml:"location"` +} + +// Specify environmental constraints. +type EnvConstraint struct { + Name string `yaml:"name"` + Version string `yaml:"version"` + Extensions []string `yaml:"extensions,omitempty"` + APIGroups []string `yaml:"apiGroups,omitempty"` +} + +// LoadChartfile loads a Chart.yaml file into a *Chart. +func LoadChartfile(filename string) (*Chartfile, error) { + b, err := ioutil.ReadFile(filename) + if err != nil { + return nil, err + } + var y Chartfile + return &y, yaml.Unmarshal(b, &y) +} + +// Save saves a Chart.yaml file +func (c *Chartfile) Save(filename string) error { + b, err := yaml.Marshal(c) + if err != nil { + return err + } + + return ioutil.WriteFile(filename, b, 0644) +} + +// VersionOK returns true if the given version meets the constraints. +// +// It returns false if the version string or constraint is unparsable or if the +// version does not meet the constraint. +func (d *Dependency) VersionOK(version string) bool { + c, err := semver.NewConstraint(d.Version) + if err != nil { + return false + } + v, err := semver.NewVersion(version) + if err != nil { + return false + } + + return c.Check(v) +} diff --git a/chart/chartfile_test.go b/chart/chartfile_test.go new file mode 100644 index 000000000..d1d21d3f3 --- /dev/null +++ b/chart/chartfile_test.go @@ -0,0 +1,58 @@ +package chart + +import ( + "testing" +) + +func TestLoadChartfile(t *testing.T) { + f, err := LoadChartfile(testfile) + if err != nil { + t.Errorf("Failed to open %s: %s", testfile, err) + return + } + + if len(f.Environment[0].Extensions) != 2 { + t.Errorf("Expected two extensions, got %d", len(f.Environment[0].Extensions)) + } + + if f.Name != "frobnitz" { + t.Errorf("Expected frobnitz, got %s", f.Name) + } + + if len(f.Maintainers) != 2 { + t.Errorf("Expected 2 maintainers, got %d", len(f.Maintainers)) + } + + if len(f.Dependencies) != 1 { + t.Errorf("Expected 2 dependencies, got %d", len(f.Dependencies)) + } + + if f.Dependencies[0].Name != "thingerbob" { + t.Errorf("Expected second dependency to be thingerbob: %q", f.Dependencies[0].Name) + } + + if f.Source[0] != "https://example.com/foo/bar" { + t.Errorf("Expected https://example.com/foo/bar, got %s", f.Source) + } +} + +func TestVersionOK(t *testing.T) { + f, err := LoadChartfile(testfile) + if err != nil { + t.Errorf("Error loading %s: %s", testfile, err) + } + + // These are canaries. The SemVer package exhuastively tests the + // various permutations. This will alert us if we wired it up + // incorrectly. + + d := f.Dependencies[0] + if d.VersionOK("1.0.0") { + t.Errorf("1.0.0 should have been marked out of range") + } + + if !d.VersionOK("3.2.3") { + t.Errorf("Version 3.2.3 should have been marked in-range") + } + +} diff --git a/chart/doc.go b/chart/doc.go new file mode 100644 index 000000000..521446e07 --- /dev/null +++ b/chart/doc.go @@ -0,0 +1,6 @@ +/* Package chart implements the Chart format. + +This package provides tools for working with the Chart format, including the +Chartfile (chart.yaml) and compressed chart archives. +*/ +package chart diff --git a/chart/testdata/README.md b/chart/testdata/README.md new file mode 100644 index 000000000..6ddc704f5 --- /dev/null +++ b/chart/testdata/README.md @@ -0,0 +1,9 @@ +The testdata directory here holds charts that match the specification. + +The `fromnitz/` directory contains a chart that matches the chart +specification. + +The `frobnitz-0.0.1.tgz` file is an archive of the `frobnitz` directory. + +The `ill` chart and directory is a chart that is not 100% compatible, +but which should still be parseable. diff --git a/chart/testdata/frobnitz-0.0.1.tgz b/chart/testdata/frobnitz-0.0.1.tgz new file mode 100644 index 000000000..79d611a5d Binary files /dev/null and b/chart/testdata/frobnitz-0.0.1.tgz differ diff --git a/chart/testdata/frobnitz/Chart.yaml b/chart/testdata/frobnitz/Chart.yaml new file mode 100644 index 000000000..9572f010c --- /dev/null +++ b/chart/testdata/frobnitz/Chart.yaml @@ -0,0 +1,28 @@ +#helm:generate foo +name: frobnitz +description: This is a frobniz. +version: "1.2.3-alpha.1+12345" +keywords: + - frobnitz + - sprocket + - dodad +maintainers: + - name: The Helm Team + email: helm@example.com + - name: Someone Else + email: nobody@example.com +source: + - https://example.com/foo/bar +home: http://example.com +dependencies: + - name: thingerbob + location: https://example.com/charts/thingerbob-3.2.1.tgz + version: ^3 +environment: + - name: Kubernetes + version: ~1.1 + extensions: + - extensions/v1beta1 + - extensions/v1beta1/daemonset + apiGroups: + - 3rdParty diff --git a/chart/testdata/frobnitz/LICENSE b/chart/testdata/frobnitz/LICENSE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/chart/testdata/frobnitz/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/chart/testdata/frobnitz/README.md b/chart/testdata/frobnitz/README.md new file mode 100644 index 000000000..8cf4cc3d7 --- /dev/null +++ b/chart/testdata/frobnitz/README.md @@ -0,0 +1,11 @@ +# Frobnitz + +This is an example chart. + +## Usage + +This is an example. It has no usage. + +## Development + +For developer info, see the top-level repository. diff --git a/chart/testdata/frobnitz/docs/README.md b/chart/testdata/frobnitz/docs/README.md new file mode 100644 index 000000000..d40747caf --- /dev/null +++ b/chart/testdata/frobnitz/docs/README.md @@ -0,0 +1 @@ +This is a placeholder for documentation. diff --git a/chart/testdata/frobnitz/hooks/pre-install.py b/chart/testdata/frobnitz/hooks/pre-install.py new file mode 100644 index 000000000..c9b0d0a92 --- /dev/null +++ b/chart/testdata/frobnitz/hooks/pre-install.py @@ -0,0 +1 @@ +# Placeholder. diff --git a/chart/testdata/frobnitz/templates/wordpress-resources.yaml b/chart/testdata/frobnitz/templates/wordpress-resources.yaml new file mode 100644 index 000000000..00f709de0 --- /dev/null +++ b/chart/testdata/frobnitz/templates/wordpress-resources.yaml @@ -0,0 +1,12 @@ +# Google Cloud Deployment Manager template +resources: +- name: nfs-disk + type: compute.v1.disk + properties: + zone: us-central1-b + sizeGb: 200 +- name: mysql-disk + type: compute.v1.disk + properties: + zone: us-central1-b + sizeGb: 200 diff --git a/chart/testdata/frobnitz/templates/wordpress.jinja b/chart/testdata/frobnitz/templates/wordpress.jinja new file mode 100644 index 000000000..f34e4fec9 --- /dev/null +++ b/chart/testdata/frobnitz/templates/wordpress.jinja @@ -0,0 +1,72 @@ +#helm:generate dm_template +{% set PROPERTIES = properties or {} %} +{% set PROJECT = PROPERTIES['project'] or 'dm-k8s-testing' %} +{% set NFS_SERVER = PROPERTIES['nfs-server'] or {} %} +{% set NFS_SERVER_IP = NFS_SERVER['ip'] or '10.0.253.247' %} +{% set NFS_SERVER_PORT = NFS_SERVER['port'] or 2049 %} +{% set NFS_SERVER_DISK = NFS_SERVER['disk'] or 'nfs-disk' %} +{% set NFS_SERVER_DISK_FSTYPE = NFS_SERVER['fstype'] or 'ext4' %} +{% set NGINX = PROPERTIES['nginx'] or {} %} +{% set NGINX_PORT = 80 %} +{% set NGINX_REPLICAS = NGINX['replicas'] or 2 %} +{% set WORDPRESS_PHP = PROPERTIES['wordpress-php'] or {} %} +{% set WORDPRESS_PHP_REPLICAS = WORDPRESS_PHP['replicas'] or 2 %} +{% set WORDPRESS_PHP_PORT = WORDPRESS_PHP['port'] or 9000 %} +{% set MYSQL = PROPERTIES['mysql'] or {} %} +{% set MYSQL_PORT = MYSQL['port'] or 3306 %} +{% set MYSQL_PASSWORD = MYSQL['password'] or 'mysql-password' %} +{% set MYSQL_DISK = MYSQL['disk'] or 'mysql-disk' %} +{% set MYSQL_DISK_FSTYPE = MYSQL['fstype'] or 'ext4' %} + +resources: +- name: nfs + type: github.com/kubernetes/application-dm-templates/storage/nfs:v1 + properties: + ip: {{ NFS_SERVER_IP }} + port: {{ NFS_SERVER_PORT }} + disk: {{ NFS_SERVER_DISK }} + fstype: {{NFS_SERVER_DISK_FSTYPE }} +- name: nginx + type: github.com/kubernetes/application-dm-templates/common/replicatedservice:v2 + properties: + service_port: {{ NGINX_PORT }} + container_port: {{ NGINX_PORT }} + replicas: {{ NGINX_REPLICAS }} + external_service: true + image: gcr.io/{{ PROJECT }}/nginx:latest + volumes: + - mount_path: /var/www/html + persistentVolumeClaim: + claimName: nfs +- name: mysql + type: github.com/kubernetes/application-dm-templates/common/replicatedservice:v2 + properties: + service_port: {{ MYSQL_PORT }} + container_port: {{ MYSQL_PORT }} + replicas: 1 + image: mysql:5.6 + env: + - name: MYSQL_ROOT_PASSWORD + value: {{ MYSQL_PASSWORD }} + volumes: + - mount_path: /var/lib/mysql + gcePersistentDisk: + pdName: {{ MYSQL_DISK }} + fsType: {{ MYSQL_DISK_FSTYPE }} +- name: wordpress-php + type: github.com/kubernetes/application-dm-templates/common/replicatedservice:v2 + properties: + service_name: wordpress-php + service_port: {{ WORDPRESS_PHP_PORT }} + container_port: {{ WORDPRESS_PHP_PORT }} + replicas: 2 + image: wordpress:fpm + env: + - name: WORDPRESS_DB_PASSWORD + value: {{ MYSQL_PASSWORD }} + - name: WORDPRESS_DB_HOST + value: mysql-service + volumes: + - mount_path: /var/www/html + persistentVolumeClaim: + claimName: nfs diff --git a/chart/testdata/frobnitz/templates/wordpress.jinja.schema b/chart/testdata/frobnitz/templates/wordpress.jinja.schema new file mode 100644 index 000000000..215b47e1e --- /dev/null +++ b/chart/testdata/frobnitz/templates/wordpress.jinja.schema @@ -0,0 +1,69 @@ +info: + title: Wordpress + description: | + Defines a Wordpress website by defining four replicated services: an NFS service, an nginx service, a wordpress-php service, and a MySQL service. + + The nginx service and the Wordpress-php service both use NFS to share files. + +properties: + project: + type: string + default: dm-k8s-testing + description: Project location to load the images from. + nfs-service: + type: object + properties: + ip: + type: string + default: 10.0.253.247 + description: The IP of the NFS service. + port: + type: int + default: 2049 + description: The port of the NFS service. + disk: + type: string + default: nfs-disk + description: The name of the persistent disk the NFS service uses. + fstype: + type: string + default: ext4 + description: The filesystem the disk of the NFS service uses. + nginx: + type: object + properties: + replicas: + type: int + default: 2 + description: The number of replicas for the nginx service. + wordpress-php: + type: object + properties: + replicas: + type: int + default: 2 + description: The number of replicas for the wordpress-php service. + port: + type: int + default: 9000 + description: The port the wordpress-php service runs on. + mysql: + type: object + properties: + port: + type: int + default: 3306 + description: The port the MySQL service runs on. + password: + type: string + default: mysql-password + description: The root password of the MySQL service. + disk: + type: string + default: mysql-disk + description: The name of the persistent disk the MySQL service uses. + fstype: + type: string + default: ext4 + description: The filesystem the disk of the MySQL service uses. + diff --git a/chart/testdata/frobnitz/templates/wordpress.yaml b/chart/testdata/frobnitz/templates/wordpress.yaml new file mode 100644 index 000000000..b401897ab --- /dev/null +++ b/chart/testdata/frobnitz/templates/wordpress.yaml @@ -0,0 +1,6 @@ +imports: +- path: wordpress.jinja + +resources: +- name: wordpress + type: wordpress.jinja diff --git a/chart/testdata/ill-1.2.3.tgz b/chart/testdata/ill-1.2.3.tgz new file mode 100644 index 000000000..bb4d5d499 Binary files /dev/null and b/chart/testdata/ill-1.2.3.tgz differ diff --git a/chart/testdata/ill/Chart.yaml b/chart/testdata/ill/Chart.yaml new file mode 100644 index 000000000..1256cea32 --- /dev/null +++ b/chart/testdata/ill/Chart.yaml @@ -0,0 +1,28 @@ +#helm:generate foo +name: ill +description: This is a frobniz. +version: "1.2.3-alpha.1+12345" +keywords: + - ill + - sprocket + - dodad +maintainers: + - name: The Helm Team + email: helm@example.com + - name: Someone Else + email: nobody@example.com +source: + - https://example.com/foo/bar +home: http://example.com +dependencies: + - name: thingerbob + location: https://example.com/charts/thingerbob-3.2.1.tgz + version: ^3 +environment: + - name: Kubernetes + version: ~1.1 + extensions: + - extensions/v1beta1 + - extensions/v1beta1/daemonset + apiGroups: + - 3rdParty diff --git a/chart/testdata/ill/LICENSE b/chart/testdata/ill/LICENSE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/chart/testdata/ill/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/chart/testdata/ill/README.md b/chart/testdata/ill/README.md new file mode 100644 index 000000000..8cf4cc3d7 --- /dev/null +++ b/chart/testdata/ill/README.md @@ -0,0 +1,11 @@ +# Frobnitz + +This is an example chart. + +## Usage + +This is an example. It has no usage. + +## Development + +For developer info, see the top-level repository. diff --git a/chart/testdata/ill/docs/README.md b/chart/testdata/ill/docs/README.md new file mode 100644 index 000000000..d40747caf --- /dev/null +++ b/chart/testdata/ill/docs/README.md @@ -0,0 +1 @@ +This is a placeholder for documentation. diff --git a/chart/testdata/ill/hooks/pre-install.py b/chart/testdata/ill/hooks/pre-install.py new file mode 100644 index 000000000..c9b0d0a92 --- /dev/null +++ b/chart/testdata/ill/hooks/pre-install.py @@ -0,0 +1 @@ +# Placeholder. diff --git a/chart/testdata/ill/templates/wordpress-resources.yaml b/chart/testdata/ill/templates/wordpress-resources.yaml new file mode 100644 index 000000000..00f709de0 --- /dev/null +++ b/chart/testdata/ill/templates/wordpress-resources.yaml @@ -0,0 +1,12 @@ +# Google Cloud Deployment Manager template +resources: +- name: nfs-disk + type: compute.v1.disk + properties: + zone: us-central1-b + sizeGb: 200 +- name: mysql-disk + type: compute.v1.disk + properties: + zone: us-central1-b + sizeGb: 200 diff --git a/chart/testdata/ill/templates/wordpress.jinja b/chart/testdata/ill/templates/wordpress.jinja new file mode 100644 index 000000000..f34e4fec9 --- /dev/null +++ b/chart/testdata/ill/templates/wordpress.jinja @@ -0,0 +1,72 @@ +#helm:generate dm_template +{% set PROPERTIES = properties or {} %} +{% set PROJECT = PROPERTIES['project'] or 'dm-k8s-testing' %} +{% set NFS_SERVER = PROPERTIES['nfs-server'] or {} %} +{% set NFS_SERVER_IP = NFS_SERVER['ip'] or '10.0.253.247' %} +{% set NFS_SERVER_PORT = NFS_SERVER['port'] or 2049 %} +{% set NFS_SERVER_DISK = NFS_SERVER['disk'] or 'nfs-disk' %} +{% set NFS_SERVER_DISK_FSTYPE = NFS_SERVER['fstype'] or 'ext4' %} +{% set NGINX = PROPERTIES['nginx'] or {} %} +{% set NGINX_PORT = 80 %} +{% set NGINX_REPLICAS = NGINX['replicas'] or 2 %} +{% set WORDPRESS_PHP = PROPERTIES['wordpress-php'] or {} %} +{% set WORDPRESS_PHP_REPLICAS = WORDPRESS_PHP['replicas'] or 2 %} +{% set WORDPRESS_PHP_PORT = WORDPRESS_PHP['port'] or 9000 %} +{% set MYSQL = PROPERTIES['mysql'] or {} %} +{% set MYSQL_PORT = MYSQL['port'] or 3306 %} +{% set MYSQL_PASSWORD = MYSQL['password'] or 'mysql-password' %} +{% set MYSQL_DISK = MYSQL['disk'] or 'mysql-disk' %} +{% set MYSQL_DISK_FSTYPE = MYSQL['fstype'] or 'ext4' %} + +resources: +- name: nfs + type: github.com/kubernetes/application-dm-templates/storage/nfs:v1 + properties: + ip: {{ NFS_SERVER_IP }} + port: {{ NFS_SERVER_PORT }} + disk: {{ NFS_SERVER_DISK }} + fstype: {{NFS_SERVER_DISK_FSTYPE }} +- name: nginx + type: github.com/kubernetes/application-dm-templates/common/replicatedservice:v2 + properties: + service_port: {{ NGINX_PORT }} + container_port: {{ NGINX_PORT }} + replicas: {{ NGINX_REPLICAS }} + external_service: true + image: gcr.io/{{ PROJECT }}/nginx:latest + volumes: + - mount_path: /var/www/html + persistentVolumeClaim: + claimName: nfs +- name: mysql + type: github.com/kubernetes/application-dm-templates/common/replicatedservice:v2 + properties: + service_port: {{ MYSQL_PORT }} + container_port: {{ MYSQL_PORT }} + replicas: 1 + image: mysql:5.6 + env: + - name: MYSQL_ROOT_PASSWORD + value: {{ MYSQL_PASSWORD }} + volumes: + - mount_path: /var/lib/mysql + gcePersistentDisk: + pdName: {{ MYSQL_DISK }} + fsType: {{ MYSQL_DISK_FSTYPE }} +- name: wordpress-php + type: github.com/kubernetes/application-dm-templates/common/replicatedservice:v2 + properties: + service_name: wordpress-php + service_port: {{ WORDPRESS_PHP_PORT }} + container_port: {{ WORDPRESS_PHP_PORT }} + replicas: 2 + image: wordpress:fpm + env: + - name: WORDPRESS_DB_PASSWORD + value: {{ MYSQL_PASSWORD }} + - name: WORDPRESS_DB_HOST + value: mysql-service + volumes: + - mount_path: /var/www/html + persistentVolumeClaim: + claimName: nfs diff --git a/chart/testdata/ill/templates/wordpress.jinja.schema b/chart/testdata/ill/templates/wordpress.jinja.schema new file mode 100644 index 000000000..215b47e1e --- /dev/null +++ b/chart/testdata/ill/templates/wordpress.jinja.schema @@ -0,0 +1,69 @@ +info: + title: Wordpress + description: | + Defines a Wordpress website by defining four replicated services: an NFS service, an nginx service, a wordpress-php service, and a MySQL service. + + The nginx service and the Wordpress-php service both use NFS to share files. + +properties: + project: + type: string + default: dm-k8s-testing + description: Project location to load the images from. + nfs-service: + type: object + properties: + ip: + type: string + default: 10.0.253.247 + description: The IP of the NFS service. + port: + type: int + default: 2049 + description: The port of the NFS service. + disk: + type: string + default: nfs-disk + description: The name of the persistent disk the NFS service uses. + fstype: + type: string + default: ext4 + description: The filesystem the disk of the NFS service uses. + nginx: + type: object + properties: + replicas: + type: int + default: 2 + description: The number of replicas for the nginx service. + wordpress-php: + type: object + properties: + replicas: + type: int + default: 2 + description: The number of replicas for the wordpress-php service. + port: + type: int + default: 9000 + description: The port the wordpress-php service runs on. + mysql: + type: object + properties: + port: + type: int + default: 3306 + description: The port the MySQL service runs on. + password: + type: string + default: mysql-password + description: The root password of the MySQL service. + disk: + type: string + default: mysql-disk + description: The name of the persistent disk the MySQL service uses. + fstype: + type: string + default: ext4 + description: The filesystem the disk of the MySQL service uses. + diff --git a/chart/testdata/ill/templates/wordpress.yaml b/chart/testdata/ill/templates/wordpress.yaml new file mode 100644 index 000000000..b401897ab --- /dev/null +++ b/chart/testdata/ill/templates/wordpress.yaml @@ -0,0 +1,6 @@ +imports: +- path: wordpress.jinja + +resources: +- name: wordpress + type: wordpress.jinja diff --git a/chart/testdata/nochart.tgz b/chart/testdata/nochart.tgz new file mode 100644 index 000000000..f5a235537 Binary files /dev/null and b/chart/testdata/nochart.tgz differ diff --git a/expandybird/gotpl/template.go b/expandybird/gotpl/template.go new file mode 100644 index 000000000..51f6b7c47 --- /dev/null +++ b/expandybird/gotpl/template.go @@ -0,0 +1,26 @@ +package action + +import ( + "io" + "text/template" + + "github.com/Masterminds/sprig" + "github.com/kubernetes/deployment-manager/log" +) + +// Render renders a template and values into an output stream. +// +// tpl should be a string template. +func Render(out io.Writer, tpl string, vals interface{}) error { + t, err := template.New("helmTpl").Funcs(sprig.TxtFuncMap()).Parse(tpl) + if err != nil { + return err + } + + log.Debug("Vals: %#v", vals) + + if err := t.ExecuteTemplate(out, "helmTpl", vals); err != nil { + return err + } + return nil +} diff --git a/expandybird/gotpl/template_test.go b/expandybird/gotpl/template_test.go new file mode 100644 index 000000000..0ba55ba88 --- /dev/null +++ b/expandybird/gotpl/template_test.go @@ -0,0 +1,21 @@ +package action + +import ( + "bytes" + "testing" +) + +func TestRender(t *testing.T) { + var b bytes.Buffer + + tpl := `{{.Hello | upper}}` + vals := map[string]string{"Hello": "hello"} + + if err := Render(&b, tpl, vals); err != nil { + t.Errorf("Failed to compile/render template: %s", err) + } + + if b.String() != "HELLO" { + t.Errorf("Expected HELLO. Got %q", b.String()) + } +} diff --git a/glide.lock b/glide.lock new file mode 100644 index 000000000..5809e9d10 --- /dev/null +++ b/glide.lock @@ -0,0 +1,55 @@ +hash: 0bcb72b361ed27dccc62c1f6551b21e57c0478ffdc5b2c70c2a0cebab31b4180 +updated: 2016-01-28T16:05:55.056196328-07:00 +imports: +- name: github.com/aokoli/goutils + version: 9c37978a95bd5c709a15883b6242714ea6709e64 +- name: github.com/emicklei/go-restful + version: b86acf97a74ed7603ac78d012f5535b4d587b156 +- name: github.com/ghodss/yaml + version: 73d445a93680fa1a78ae23a5839bad48f32ba1ee +- name: github.com/golang/glog + version: 23def4e6c14b4da8ac2ed8007337bc5eb5007998 +- name: github.com/golang/protobuf + version: 45bba206dd5270d96bac4942dcfe515726613249 +- name: github.com/google/go-github + version: b8b4ac742977310ff6e75140a403a38dab109977 + subpackages: + - /github +- name: github.com/google/go-querystring + version: 2a60fc2ba6c19de80291203597d752e9ba58e4c0 +- name: github.com/gorilla/context + version: 1c83b3eabd45b6d76072b66b746c20815fb2872d +- name: github.com/gorilla/handlers + version: 44328eee346b9614b3fe8ca84e72fe23736afbfb +- name: github.com/gorilla/mux + version: 26a6070f849969ba72b72256e9f14cf519751690 +- name: github.com/gorilla/schema + version: 14c555599c2a4f493c1e13fd1ea6fdf721739028 +- name: github.com/Masterminds/semver + version: c4f7ef0702f269161a60489ccbbc9f1241ad1265 +- name: github.com/Masterminds/sprig + version: 93e0202ba8792558ba3767a3707d8e896eda95c0 +- name: github.com/mjibson/appstats + version: 0542d5f0e87ea3a8fa4174322b9532f5d04f9fa8 +- name: golang.org/x/crypto + version: 1f22c0103821b9390939b6776727195525381532 +- name: golang.org/x/net + version: 04b9de9b512f58addf28c9853d50ebef61c3953e +- name: golang.org/x/oauth2 + version: 8a57ed94ffd43444c0879fe75701732a38afc985 +- name: golang.org/x/text + version: 6d3c22c4525a4da167968fa2479be5524d2e8bd0 +- name: google.golang.com/appengine + version: "" + repo: https://google.golang.com/appengine +- name: google.golang.org/api + version: f6ba98773d96b877b246f3a9266493dfc11e276b +- name: google.golang.org/appengine + version: 6bde959377a90acb53366051d7d587bfd7171354 +- name: google.golang.org/cloud + version: fb10e8da373d97f6ba5e648299a10b3b91f14cd5 +- name: google.golang.org/grpc + version: 23d551898cf40a24d0ce7a859c75b322a7035673 +- name: gopkg.in/yaml.v2 + version: f7716cbe52baa25d2e9b0d0da546fcf909fc16b4 +devImports: [] diff --git a/glide.yaml b/glide.yaml new file mode 100644 index 000000000..818716509 --- /dev/null +++ b/glide.yaml @@ -0,0 +1,12 @@ +package: github.com/kubernetes/deployment-manager +import: +- package: github.com/emicklei/go-restful +- package: github.com/ghodss/yaml +- package: github.com/google/go-github + subpackages: + - /github +- package: github.com/gorilla/handlers +- package: github.com/gorilla/mux +- package: gopkg.in/yaml.v2 +- package: github.com/Masterminds/semver +- package: github.com/Masterminds/sprig diff --git a/log/log.go b/log/log.go new file mode 100644 index 000000000..8d74d4878 --- /dev/null +++ b/log/log.go @@ -0,0 +1,51 @@ +/* Package log provides simple convenience wrappers for logging. + +Following convention, this provides functions for logging warnings, errors, information +and debugging. +*/ +package log + +import ( + "log" + "os" +) + +// LogReceiver can receive log messages from this package. +type LogReceiver interface { + Printf(format string, v ...interface{}) +} + +// Logger is the destination for this package. +// +// The logger that this prints to. +var Logger LogReceiver = log.New(os.Stderr, "", log.LstdFlags) + +// IsDebugging controls debugging output. +// +// If this is true, debugging messages will be printed. Expensive debugging +// operations can be wrapped in `if log.IsDebugging {}`. +var IsDebugging bool = false + +// Err prints an error of severity ERROR to the log. +func Err(msg string, v ...interface{}) { + Logger.Printf("[ERROR] "+msg+"\n", v...) +} + +// Warn prints an error severity WARN to the log. +func Warn(msg string, v ...interface{}) { + Logger.Printf("[WARN] "+msg+"\n", v...) +} + +// Info prints an error of severity INFO to the log. +func Info(msg string, v ...interface{}) { + Logger.Printf("[INFO] "+msg+"\n", v...) +} + +// Debug prints an error severity DEBUG to the log. +// +// Debug will only print if IsDebugging is true. +func Debug(msg string, v ...interface{}) { + if IsDebugging { + Logger.Printf("[DEBUG] "+msg+"\n", v...) + } +} diff --git a/log/log_test.go b/log/log_test.go new file mode 100644 index 000000000..3a10b8d2a --- /dev/null +++ b/log/log_test.go @@ -0,0 +1,49 @@ +package log + +import ( + "bytes" + "fmt" + "testing" +) + +type LoggerMock struct { + b bytes.Buffer +} + +func (l *LoggerMock) Printf(m string, v ...interface{}) { + l.b.Write([]byte(fmt.Sprintf(m, v...))) +} + +func TestLogger(t *testing.T) { + l := &LoggerMock{} + Logger = l + IsDebugging = true + + Err("%s%s%s", "a", "b", "c") + expect := "[ERROR] abc\n" + if l.b.String() != expect { + t.Errorf("Expected %q, got %q", expect, l.b.String()) + } + l.b.Reset() + + tests := map[string]func(string, ...interface{}){ + "[WARN] test\n": Warn, + "[INFO] test\n": Info, + "[DEBUG] test\n": Debug, + } + + for expect, f := range tests { + f("test") + if l.b.String() != expect { + t.Errorf("Expected %q, got %q", expect, l.b.String()) + } + l.b.Reset() + } + + IsDebugging = false + Debug("HELLO") + if l.b.String() != "" { + t.Errorf("Expected debugging to disable. Got %q", l.b.String()) + } + l.b.Reset() +}