Compare commits
71 Commits
v0.3.0
...
eks-suppor
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9c1ed849ab | ||
|
|
d8d2e33b20 | ||
|
|
3b78f01b45 | ||
|
|
24060c18fc | ||
|
|
232bb5eb96 | ||
|
|
c0964ae178 | ||
|
|
9f9e83da99 | ||
|
|
39aea4c8dd | ||
|
|
7e25218945 | ||
|
|
3b85c38714 | ||
|
|
1422ec77a4 | ||
|
|
2a13fff548 | ||
|
|
d53a1ed942 | ||
|
|
fc3bfc466a | ||
|
|
8f2d4bec49 | ||
|
|
b2066961e1 | ||
|
|
253a4465f8 | ||
|
|
8857782826 | ||
|
|
81c4877a92 | ||
|
|
fbfb69f063 | ||
|
|
568f613401 | ||
|
|
dc05855aa5 | ||
|
|
a71bba71fd | ||
|
|
f00f6a6329 | ||
|
|
1a70a626ea | ||
|
|
4f549ddf2a | ||
|
|
4cd369b051 | ||
|
|
6b331fdf03 | ||
|
|
801598e1c5 | ||
|
|
cb58b5a021 | ||
|
|
d86ac72529 | ||
|
|
52c9fb552c | ||
|
|
d4506608d7 | ||
|
|
ff8e988122 | ||
|
|
ef66bc0f92 | ||
|
|
08ddf5e27a | ||
|
|
4ba1e694d9 | ||
|
|
10e7e7fee5 | ||
|
|
285e9d98a4 | ||
|
|
db87bd0507 | ||
|
|
e2f53f3b08 | ||
|
|
c4c136b021 | ||
|
|
ef4db923cd | ||
|
|
ae9cb59a1f | ||
|
|
ad5baea3e6 | ||
|
|
4755f502b5 | ||
|
|
59a591eda5 | ||
|
|
3d1c849e75 | ||
|
|
3eb90651d1 | ||
|
|
044caebafd | ||
|
|
dc4ecb6b91 | ||
|
|
cab3a8ae95 | ||
|
|
197a377a82 | ||
|
|
aed59c251e | ||
|
|
2d4688f99b | ||
|
|
420014f9e5 | ||
|
|
285af8a317 | ||
|
|
485eb4375c | ||
|
|
80b26434f5 | ||
|
|
161960e55e | ||
|
|
5e2f2f3dc6 | ||
|
|
f373004bd2 | ||
|
|
0c5576164d | ||
|
|
f4ce27f40e | ||
|
|
6452a01c82 | ||
|
|
b091bc2a95 | ||
|
|
68a2c3cc86 | ||
|
|
7849b28532 | ||
|
|
5de156f823 | ||
|
|
f398ee5724 | ||
|
|
a21d6ad61f |
15
.drone.yml
15
.drone.yml
@@ -17,11 +17,16 @@ steps:
|
|||||||
image: golang:1.13
|
image: golang:1.13
|
||||||
commands:
|
commands:
|
||||||
- go build -o build/drone-helm cmd/drone-helm/main.go
|
- go build -o build/drone-helm cmd/drone-helm/main.go
|
||||||
- name: publish
|
- name: publish_linux_amd64
|
||||||
image: plugins/docker
|
image: plugins/docker
|
||||||
auto_tag: true
|
|
||||||
settings:
|
settings:
|
||||||
|
auto_tag: true
|
||||||
|
username:
|
||||||
|
from_secret: docker_username
|
||||||
|
password:
|
||||||
|
from_secret: docker_password
|
||||||
|
repo:
|
||||||
|
from_secret: plugin_repo
|
||||||
dockerfile: Dockerfile
|
dockerfile: Dockerfile
|
||||||
registry: '192.168.0.17:5000'
|
when:
|
||||||
repo: 192.168.0.17:5000/drone-helm3
|
event: [ tag, push ]
|
||||||
insecure: true
|
|
||||||
|
|||||||
1
.github/CODEOWNERS
vendored
Normal file
1
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
* @erincall @grinnellian @kav @josmo
|
||||||
17
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
17
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Unexpected or broken behavior
|
||||||
|
title: ''
|
||||||
|
labels: bug
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**What I tried to do:**
|
||||||
|
<!-- e.g. run a helm installation -->
|
||||||
|
|
||||||
|
**What happened:**
|
||||||
|
<!-- describe the faulty behavior -->
|
||||||
|
|
||||||
|
**More info:**
|
||||||
|
<!-- contents of .drone.yml, etc. -->
|
||||||
14
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
14
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest a new feature
|
||||||
|
title: ''
|
||||||
|
labels: enhancement
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**The problem I'm trying to solve:**
|
||||||
|
<!-- describe what you'd like to be able to accomplish -->
|
||||||
|
|
||||||
|
**How I imagine it working:**
|
||||||
|
<!-- e.g. configuration that could go in .drone.yml -->
|
||||||
8
.github/pull_request_template.md
vendored
Normal file
8
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
**Please replace this line with "fixes #ISSUE_NUMBER" (or "relates to #ISSUE_NUMBER", if it is not a complete fix)**
|
||||||
|
|
||||||
|
Pre-merge checklist:
|
||||||
|
|
||||||
|
* [ ] Code changes have tests
|
||||||
|
* [ ] Any changes to the config are documented in `docs/parameter_reference.md`
|
||||||
|
* [ ] Any new _required_ config is documented in `README.md`
|
||||||
|
* [ ] Any large changes have been verified by running a Drone job
|
||||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -13,3 +13,5 @@
|
|||||||
|
|
||||||
# Dependency directories (remove the comment below to include it)
|
# Dependency directories (remove the comment below to include it)
|
||||||
# vendor/
|
# vendor/
|
||||||
|
.env
|
||||||
|
.secrets
|
||||||
|
|||||||
76
CODE_OF_CONDUCT.md
Normal file
76
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,76 @@
|
|||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
In the interest of fostering an open and welcoming environment, we as
|
||||||
|
contributors and maintainers pledge to making participation in our project and
|
||||||
|
our community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
||||||
|
level of experience, education, socio-economic status, nationality, personal
|
||||||
|
appearance, race, religion, or sexual identity and orientation.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to creating a positive environment
|
||||||
|
include:
|
||||||
|
|
||||||
|
* Using welcoming and inclusive language
|
||||||
|
* Being respectful of differing viewpoints and experiences
|
||||||
|
* Gracefully accepting constructive criticism
|
||||||
|
* Focusing on what is best for the community
|
||||||
|
* Showing empathy towards other community members
|
||||||
|
|
||||||
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||||
|
advances
|
||||||
|
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or electronic
|
||||||
|
address, without explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Our Responsibilities
|
||||||
|
|
||||||
|
Project maintainers are responsible for clarifying the standards of acceptable
|
||||||
|
behavior and are expected to take appropriate and fair corrective action in
|
||||||
|
response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
|
Project maintainers have the right and responsibility to remove, edit, or
|
||||||
|
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||||
|
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||||
|
permanently any contributor for other behaviors that they deem inappropriate,
|
||||||
|
threatening, offensive, or harmful.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies both within project spaces and in public spaces
|
||||||
|
when an individual is representing the project or its community. Examples of
|
||||||
|
representing a project or community include using an official project e-mail
|
||||||
|
address, posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event. Representation of a project may be
|
||||||
|
further defined and clarified by project maintainers.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported by contacting the project team at [workwithus@pelo.tech](mailto:workwithus@pelo.tech). All
|
||||||
|
complaints will be reviewed and investigated and will result in a response that
|
||||||
|
is deemed necessary and appropriate to the circumstances. The project team is
|
||||||
|
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||||
|
Further details of specific enforcement policies may be posted separately.
|
||||||
|
|
||||||
|
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||||
|
faith may face temporary or permanent repercussions as determined by other
|
||||||
|
members of the project's leadership.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||||
|
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see
|
||||||
|
https://www.contributor-covenant.org/faq
|
||||||
@@ -2,7 +2,7 @@ FROM alpine/helm
|
|||||||
MAINTAINER Erin Call <erin@liffft.com>
|
MAINTAINER Erin Call <erin@liffft.com>
|
||||||
|
|
||||||
COPY build/drone-helm /bin/drone-helm
|
COPY build/drone-helm /bin/drone-helm
|
||||||
COPY kubeconfig /root/.kube/config.tpl
|
COPY assets/kubeconfig.tpl /root/.kube/config.tpl
|
||||||
|
|
||||||
LABEL description="Helm 3 plugin for Drone 3"
|
LABEL description="Helm 3 plugin for Drone 3"
|
||||||
LABEL base="alpine/helm"
|
LABEL base="alpine/helm"
|
||||||
|
|||||||
674
LICENSE
674
LICENSE
@@ -1,674 +0,0 @@
|
|||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
|
||||||
GNU General Public License for most of our software; it applies also to
|
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
|
||||||
or can get the source code. And you must show them these terms so they
|
|
||||||
know their rights.
|
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
|
||||||
that there is no warranty for this free software. For both users' and
|
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
|
||||||
changed, so that their problems will not be attributed erroneously to
|
|
||||||
authors of previous versions.
|
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the special requirements of the GNU Affero General Public License,
|
|
||||||
section 13, concerning interaction through a network will apply to the
|
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
|
||||||
notice like this when it starts in an interactive mode:
|
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
||||||
70
README.md
70
README.md
@@ -1,3 +1,71 @@
|
|||||||
# Drone plugin for Helm 3
|
# Drone plugin for Helm 3
|
||||||
|
|
||||||
Dissatisfied with this empty README? Consider grabbing [the "put stuff in the README" issue](https://github.com/pelotech/drone-helm3/issues/8)!
|
This plugin provides an interface between [Drone](https://drone.io/) and [Helm 3](https://github.com/kubernetes/helm):
|
||||||
|
|
||||||
|
* Lint your charts
|
||||||
|
* Deploy your service
|
||||||
|
* Delete your service
|
||||||
|
|
||||||
|
The plugin is inpsired by [drone-helm](https://github.com/ipedrazas/drone-helm), which fills the same role for Helm 2. It provides a comparable feature-set and the configuration settings are backwards-compatible.
|
||||||
|
|
||||||
|
## Example configuration
|
||||||
|
|
||||||
|
The examples below give a minimal and sufficient configuration for each use-case. For a full description of each command's settings, see [docs/parameter_reference.md](docs/parameter_reference.md).
|
||||||
|
|
||||||
|
### Linting
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
steps:
|
||||||
|
- name: lint
|
||||||
|
image: pelotech/drone-helm3
|
||||||
|
settings:
|
||||||
|
helm_command: lint
|
||||||
|
chart: ./
|
||||||
|
```
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
steps:
|
||||||
|
- name: deploy
|
||||||
|
image: pelotech/drone-helm3
|
||||||
|
settings:
|
||||||
|
helm_command: upgrade
|
||||||
|
chart: ./
|
||||||
|
release: my-project
|
||||||
|
environment:
|
||||||
|
API_SERVER: https://my.kubernetes.installation/clusters/a-1234
|
||||||
|
KUBERNETES_TOKEN:
|
||||||
|
from_secret: kubernetes_token
|
||||||
|
```
|
||||||
|
|
||||||
|
### Uninstallation
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
steps:
|
||||||
|
- name: uninstall
|
||||||
|
image: pelotech/drone-helm3
|
||||||
|
settings:
|
||||||
|
helm_command: uninstall
|
||||||
|
release: my-project
|
||||||
|
environment:
|
||||||
|
API_SERVER: https://my.kubernetes.installation/clusters/a-1234
|
||||||
|
KUBERNETES_TOKEN:
|
||||||
|
from_secret: kubernetes_token
|
||||||
|
```
|
||||||
|
|
||||||
|
## Upgrading from drone-helm
|
||||||
|
|
||||||
|
drone-helm3 is largely backwards-compatible with drone-helm. There are some known differences:
|
||||||
|
|
||||||
|
* `prefix` must be supplied via the `settings` block, not `environment`.
|
||||||
|
* Several settings no longer have any effect:
|
||||||
|
* `purge` -- this is the default behavior in Helm 3
|
||||||
|
* `recreate_pods`
|
||||||
|
* `tiller_ns`
|
||||||
|
* `upgrade`
|
||||||
|
* `canary_image`
|
||||||
|
* `client_only`
|
||||||
|
* `stable_repo_url`
|
||||||
|
|
||||||
|
Since helm 3 does not require Tiller, we also recommend switching to a service account with less-expansive permissions.
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ clusters:
|
|||||||
- cluster:
|
- cluster:
|
||||||
{{- if eq .SkipTLSVerify true }}
|
{{- if eq .SkipTLSVerify true }}
|
||||||
insecure-skip-tls-verify: true
|
insecure-skip-tls-verify: true
|
||||||
{{- else }}
|
{{- else if .Certificate }}
|
||||||
certificate-authority-data: {{ .Certificate }}
|
certificate-authority-data: {{ .Certificate }}
|
||||||
{{- end}}
|
{{- end}}
|
||||||
server: {{ .APIServer }}
|
server: {{ .APIServer }}
|
||||||
@@ -2,22 +2,21 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"github.com/kelseyhightower/envconfig"
|
|
||||||
"os"
|
"os"
|
||||||
|
|
||||||
"github.com/pelotech/drone-helm3/internal/helm"
|
"github.com/pelotech/drone-helm3/internal/helm"
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
var c helm.Config
|
cfg, err := helm.NewConfig(os.Stdout, os.Stderr)
|
||||||
|
|
||||||
if err := envconfig.Process("plugin", &c); err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(os.Stderr, "%s\n", err.Error())
|
fmt.Fprintf(os.Stderr, "%s\n", err.Error())
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// Make the plan
|
// Make the plan
|
||||||
plan, err := helm.NewPlan(c)
|
plan, err := helm.NewPlan(*cfg)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(os.Stderr, "%w\n", err)
|
fmt.Fprintf(os.Stderr, "%w\n", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
|
|||||||
48
docs/contributing.md
Normal file
48
docs/contributing.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# Contributing to drone-helm3
|
||||||
|
|
||||||
|
We're glad you're interested in contributing! Here are some guidelines that will help make sure everyone has a good experience:
|
||||||
|
|
||||||
|
## Submitting a patch
|
||||||
|
|
||||||
|
Before you start working on a change, please make sure there's an associated issue. It doesn't need to be thoroughly scrutinized and dissected, but it needs to exist.
|
||||||
|
|
||||||
|
Please put the relevant issue number in the first line of your commit messages, e.g. `vorpalize the frabjulator [#42]`. Branch names do not need issue numbers, but feel free to include them if you like.
|
||||||
|
|
||||||
|
We encourage you to follow [the guidelines in Pro Git](https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines) when making commits. In short:
|
||||||
|
|
||||||
|
* Commit early and commit often.
|
||||||
|
* Make the first line of the commit message concise--no more than 50 characters or so.
|
||||||
|
* Make the rest of the commit message verbose--information about _why_ you did what you did is particularly helpful.
|
||||||
|
|
||||||
|
Once you're satisfied with your work, send us a pull request. If you'd like, you can send the pull request _before_ you're satisfied with your work; just be sure to mark the PR a draft or put `[WIP]` in the title.
|
||||||
|
|
||||||
|
## How to run the tests
|
||||||
|
|
||||||
|
We use `go test`, `go vet`, and `golint`:
|
||||||
|
|
||||||
|
```
|
||||||
|
go test ./cmd/... ./internal/...
|
||||||
|
go vet ./cmd/... ./internal/...
|
||||||
|
golint -set_exit_status ./cmd/... ./internal/...
|
||||||
|
```
|
||||||
|
|
||||||
|
If you have [the Drone cli tool](https://docs.drone.io/cli/install/) installed, you can also use `drone exec --include test --include lint`.
|
||||||
|
|
||||||
|
## Testing the plugin end-to-end
|
||||||
|
|
||||||
|
Although we aim to make the internal tests as thorough as possible, they can't test drone-helm3's integration with drone and helm themselves. However, you can test a change manually by building an image and running it with a fixture repository.
|
||||||
|
|
||||||
|
You will need:
|
||||||
|
|
||||||
|
* Access to a docker image registry. This document assumes you'll use [Docker Hub](https://hub.docker.com).
|
||||||
|
* [The Drone cli tool](https://docs.drone.io/cli/install/).
|
||||||
|
* A fixture repository--a directory with a `.drone.yml` and a helm chart. If you don't have one handy, try adding a `.drone.yml` to a chart from [Helm's "stable" repository](https://github.com/helm/charts/tree/master/stable/).
|
||||||
|
* Access to a kubernetes cluster (unless `lint` or `dry_run` is sufficient for your purposes).
|
||||||
|
|
||||||
|
Once you have what you need, you can publish and consume an image with your changes:
|
||||||
|
|
||||||
|
1. [Create a repository on Docker Hub](https://hub.docker.com/repository/create). This document assumes you've called it drone-helm3-testing.
|
||||||
|
1. Create a `.secrets` file with your docker credentials (see [example.secrets](./example.secrets) for an example). While you can use your Docker Hub password, it's better to [generate an access token](https://hub.docker.com/settings/security) and use that instead.
|
||||||
|
1. Use Drone to build and publish an image with your changes: `drone exec --secret-file ./secrets --event push`
|
||||||
|
1. In the `.drone.yml` of your fixture repository, set the `image` for each relevant stanza to `your_dockerhub_username/drone-helm3-testing`
|
||||||
|
1. Use `drone exec` in the fixture repo to verify your changes.
|
||||||
3
docs/example.secrets
Normal file
3
docs/example.secrets
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
DOCKER_PASSWORD=your_access_token
|
||||||
|
DOCKER_USERNAME=your_dockerhub_username
|
||||||
|
PLUGIN_REPO=your_dockerhub_username/drone-helm3-testing
|
||||||
133
docs/parameter_reference.md
Normal file
133
docs/parameter_reference.md
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
# Parameter reference
|
||||||
|
|
||||||
|
## Global
|
||||||
|
| Param name | Type | Purpose |
|
||||||
|
|---------------------|-----------------|---------|
|
||||||
|
| helm_command | string | Indicates the operation to perform. Recommended, but not required. Valid options are `upgrade`, `uninstall`, `lint`, and `help`. |
|
||||||
|
| update_dependencies | boolean | Calls `helm dependency update` before running the main command. **Not currently implemented**; see [#25](https://github.com/pelotech/drone-helm3/issues/25).|
|
||||||
|
| helm_repos | list\<string\> | Calls `helm repo add $repo` before running the main command. Each string should be formatted as `repo_name=https://repo.url/`. **Not currently implemented**; see [#26](https://github.com/pelotech/drone-helm3/issues/26). |
|
||||||
|
| namespace | string | Kubernetes namespace to use for this operation. |
|
||||||
|
| prefix | string | Expect environment variables to be prefixed with the given string. For more details, see "Using the prefix setting" below. **Not currently implemented**; see [#19](https://github.com/pelotech/drone-helm3/issues/19). |
|
||||||
|
| debug | boolean | Generate debug output within drone-helm3 and pass `--debug` to all helm commands. Use with care, since the debug output may include secrets. |
|
||||||
|
|
||||||
|
## Linting
|
||||||
|
|
||||||
|
Linting is only triggered when the `helm_command` setting is "lint".
|
||||||
|
|
||||||
|
| Param name | Type | Required | Purpose |
|
||||||
|
|---------------|----------------|----------|---------|
|
||||||
|
| chart | string | yes | The chart to be linted. Must be a local path. |
|
||||||
|
| values | list\<string\> | | Chart values to use as the `--set` argument to `helm lint`. |
|
||||||
|
| string_values | list\<string\> | | Chart values to use as the `--set-string` argument to `helm lint`. |
|
||||||
|
| values_files | list\<string\> | | Values to use as `--values` arguments to `helm lint`. |
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Installations are triggered when the `helm_command` setting is "upgrade." They can also be triggered when the build was triggered by a `push`, `tag`, `deployment`, `pull_request`, `promote`, or `rollback` Drone event.
|
||||||
|
|
||||||
|
| Param name | Type | Required | Purpose |
|
||||||
|
|------------------------|----------------|----------|---------|
|
||||||
|
| chart | string | yes | The chart to use for this installation. |
|
||||||
|
| release | string | yes | The release name for helm to use. |
|
||||||
|
| api_server | string | yes | API endpoint for the Kubernetes cluster. |
|
||||||
|
| kubernetes_token | string | yes, unless using EKS | Token for authenticating to Kubernetes. |
|
||||||
|
| eks_cluster | string | | AWS EKS cluster ID. |
|
||||||
|
| eks_role_arn | string | | AWS IAM role ARN for EKS authentication. |
|
||||||
|
| service_account | string | | Service account for authenticating to Kubernetes. Default is `helm`. |
|
||||||
|
| kubernetes_certificate | string | | Base64 encoded TLS certificate used by the Kubernetes cluster's certificate authority. |
|
||||||
|
| chart_version | string | | Specific chart version to install. |
|
||||||
|
| dry_run | boolean | | Pass `--dry-run` to `helm upgrade`. |
|
||||||
|
| wait | boolean | | Wait until kubernetes resources are in a ready state before marking the installation successful. |
|
||||||
|
| timeout | duration | | Timeout for any *individual* Kubernetes operation. The installation's full runtime may exceed this duration. |
|
||||||
|
| force | boolean | | Pass `--force` to `helm upgrade`. |
|
||||||
|
| values | list\<string\> | | Chart values to use as the `--set` argument to `helm upgrade`. |
|
||||||
|
| string_values | list\<string\> | | Chart values to use as the `--set-string` argument to `helm upgrade`. |
|
||||||
|
| values_files | list\<string\> | | Values to use as `--values` arguments to `helm upgrade`. |
|
||||||
|
| reuse_values | boolean | | Reuse the values from a previous release. |
|
||||||
|
| skip_tls_verify | boolean | | Connect to the Kubernetes cluster without checking for a valid TLS certificate. Not recommended in production. |
|
||||||
|
|
||||||
|
## Uninstallation
|
||||||
|
|
||||||
|
Uninstallations are triggered when the `helm_command` setting is "uninstall" or "delete." They can also be triggered when the build was triggered by a `delete` Drone event.
|
||||||
|
|
||||||
|
| Param name | Type | Required | Purpose |
|
||||||
|
|------------------------|----------|----------|---------|
|
||||||
|
| release | string | yes | The release name for helm to use. |
|
||||||
|
| api_server | string | yes | API endpoint for the Kubernetes cluster. |
|
||||||
|
| kubernetes_token | string | yes, unless using EKS | Token for authenticating to Kubernetes. |
|
||||||
|
| eks_cluster | string | | AWS EKS cluster ID. |
|
||||||
|
| eks_role_arn | string | | AWS IAM role ARN for EKS authentication. |
|
||||||
|
| service_account | string | | Service account for authenticating to Kubernetes. Default is `helm`. |
|
||||||
|
| kubernetes_certificate | string | | Base64 encoded TLS certificate used by the Kubernetes cluster's certificate authority. |
|
||||||
|
| dry_run | boolean | | Pass `--dry-run` to `helm uninstall`. |
|
||||||
|
| timeout | duration | | Timeout for any *individual* Kubernetes operation. The uninstallation's full runtime may exceed this duration. |
|
||||||
|
| skip_tls_verify | boolean | | Connect to the Kubernetes cluster without checking for a valid TLS certificate. Not recommended in production. |
|
||||||
|
|
||||||
|
### Where to put settings
|
||||||
|
|
||||||
|
Any setting (with the exception of `prefix`; [see below](#user-content-using-the-prefix-setting)), can go in either the `settings` or `environment` section.
|
||||||
|
|
||||||
|
### Formatting non-string values
|
||||||
|
|
||||||
|
* Booleans can be yaml's `true` and `false` literals or the strings `"true"` and `"false"`.
|
||||||
|
* Durations are strings formatted with the syntax accepted by [golang's ParseDuration function](https://golang.org/pkg/time/#ParseDuration) (e.g. 5m30s)
|
||||||
|
* List\<string\>s can be a yaml sequence or a comma-separated string.
|
||||||
|
|
||||||
|
All of the following are equivalent:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
values: "foo=1,bar=2"
|
||||||
|
values: ["foo=1", "bar=2"]
|
||||||
|
values:
|
||||||
|
- foo=1
|
||||||
|
- bar=2
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that **list members must not contain commas**. Both of the following are equivalent:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
values_files: [ "./over_9,000.yml" ]
|
||||||
|
values_files: [ "./over_9", "000.yml" ]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using the `prefix` setting
|
||||||
|
|
||||||
|
Because the prefix setting is meta-configuration, it has some inherent edge-cases. Here is what it does in the cases we've thought of:
|
||||||
|
|
||||||
|
Unlike the other settings, it must be declared in the `settings` block, not `environment`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
settings:
|
||||||
|
prefix: helm # drone-helm3 will look for environment variables called HELM_VARNAME
|
||||||
|
environment:
|
||||||
|
prefix: armet # no effect
|
||||||
|
```
|
||||||
|
|
||||||
|
It does not apply to configuration in the `settings` block, only in `environment`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
settings:
|
||||||
|
prefix: helm
|
||||||
|
helm_timeout: 5m # no effect
|
||||||
|
environment:
|
||||||
|
helm_timeout: 2m # timeout will be 2 minutes
|
||||||
|
```
|
||||||
|
|
||||||
|
If the environment contains a variable in non-prefixed form, it will still be applied:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
settings:
|
||||||
|
prefix: helm
|
||||||
|
environment:
|
||||||
|
timeout: 2m # timeout will be 2 minutes
|
||||||
|
```
|
||||||
|
|
||||||
|
If the environment contains both the prefixed and non-prefixed forms, drone-helm3 will use the prefixed form:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
settings:
|
||||||
|
prefix: helm
|
||||||
|
environment:
|
||||||
|
timeout: 5m # overridden
|
||||||
|
helm_timeout: 2m # timeout will be 2 minutes
|
||||||
|
```
|
||||||
1
go.mod
1
go.mod
@@ -8,4 +8,5 @@ require (
|
|||||||
github.com/stretchr/testify v1.4.0
|
github.com/stretchr/testify v1.4.0
|
||||||
golang.org/x/lint v0.0.0-20191125180803-fdd1cda4f05f // indirect
|
golang.org/x/lint v0.0.0-20191125180803-fdd1cda4f05f // indirect
|
||||||
golang.org/x/tools v0.0.0-20191209225234-22774f7dae43 // indirect
|
golang.org/x/tools v0.0.0-20191209225234-22774f7dae43 // indirect
|
||||||
|
gopkg.in/yaml.v2 v2.2.2
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -2,62 +2,78 @@ package helm
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"strings"
|
"github.com/kelseyhightower/envconfig"
|
||||||
|
"io"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The Config struct captures the `settings` and `environment` blocks inthe application's drone
|
// The Config struct captures the `settings` and `environment` blocks in the application's drone
|
||||||
// config. Configuration in drone's `settings` block arrives as uppercase env vars matching the
|
// config. Configuration in drone's `settings` block arrives as uppercase env vars matching the
|
||||||
// config key, prefixed with `PLUGIN_`. Config from the `environment` block is *not* prefixed; any
|
// config key, prefixed with `PLUGIN_`. Config from the `environment` block is uppercased, but does
|
||||||
// keys that are likely to be in that block (i.e. things that use `from_secret` need an explicit
|
// not have the `PLUGIN_` prefix. It may, however, be prefixed with the value in `$PLUGIN_PREFIX`.
|
||||||
// `envconfig:` tag so that envconfig will look for a non-prefixed env var.
|
|
||||||
type Config struct {
|
type Config struct {
|
||||||
// Configuration for drone-helm itself
|
// Configuration for drone-helm itself
|
||||||
Command helmCommand `envconfig:"HELM_COMMAND"` // Helm command to run
|
Command string `envconfig:"HELM_COMMAND"` // Helm command to run
|
||||||
DroneEvent string `envconfig:"DRONE_BUILD_EVENT"` // Drone event that invoked this plugin.
|
DroneEvent string `envconfig:"DRONE_BUILD_EVENT"` // Drone event that invoked this plugin.
|
||||||
UpdateDependencies bool `split_words:"true"` // call `helm dependency update` before the main command
|
UpdateDependencies bool `split_words:"true"` // Call `helm dependency update` before the main command
|
||||||
Repos []string `envconfig:"HELM_REPOS"` // call `helm repo add` before the main command
|
Repos []string `envconfig:"HELM_REPOS"` // Call `helm repo add` before the main command
|
||||||
Prefix string `` // Prefix to use when looking up secret env vars
|
Prefix string `` // Prefix to use when looking up secret env vars
|
||||||
|
Debug bool `` // Generate debug output and pass --debug to all helm commands
|
||||||
|
Values string `` // Argument to pass to --set in applicable helm commands
|
||||||
|
StringValues string `split_words:"true"` // Argument to pass to --set-string in applicable helm commands
|
||||||
|
ValuesFiles []string `split_words:"true"` // Arguments to pass to --values in applicable helm commands
|
||||||
|
Namespace string `` // Kubernetes namespace for all helm commands
|
||||||
|
KubeToken string `envconfig:"KUBERNETES_TOKEN"` // Kubernetes authentication token to put in .kube/config
|
||||||
|
EKSCluster string `envconfig:"EKS_CLUSTER"` // AWS EKS Cluster ID to put in .kube/config
|
||||||
|
EKSRoleARN string `envconfig:"EKS_ROLE_ARN"` // AWS IAM role resource name to put in .kube/config
|
||||||
|
SkipTLSVerify bool `envconfig:"SKIP_TLS_VERIFY"` // Put insecure-skip-tls-verify in .kube/config
|
||||||
|
Certificate string `envconfig:"KUBERNETES_CERTIFICATE"` // The Kubernetes cluster CA's self-signed certificate (must be base64-encoded)
|
||||||
|
APIServer string `envconfig:"API_SERVER"` // The Kubernetes cluster's API endpoint
|
||||||
|
ServiceAccount string `split_words:"true"` // Account to use for connecting to the Kubernetes cluster
|
||||||
|
ChartVersion string `split_words:"true"` // Specific chart version to use in `helm upgrade`
|
||||||
|
DryRun bool `split_words:"true"` // Pass --dry-run to applicable helm commands
|
||||||
|
Wait bool `` // Pass --wait to applicable helm commands
|
||||||
|
ReuseValues bool `split_words:"true"` // Pass --reuse-values to `helm upgrade`
|
||||||
|
Timeout string `` // Argument to pass to --timeout in applicable helm commands
|
||||||
|
Chart string `` // Chart argument to use in applicable helm commands
|
||||||
|
Release string `` // Release argument to use in applicable helm commands
|
||||||
|
Force bool `` // Pass --force to applicable helm commands
|
||||||
|
|
||||||
// Global helm config
|
Stdout io.Writer `ignored:"true"`
|
||||||
Debug bool `` // global helm flag (also applies to drone-helm itself)
|
Stderr io.Writer `ignored:"true"`
|
||||||
KubeConfig string `split_words:"true" default:"/root/.kube/config"` // path to the kube config file
|
|
||||||
Values string ``
|
|
||||||
StringValues string `split_words:"true"`
|
|
||||||
ValuesFiles []string `split_words:"true"`
|
|
||||||
Namespace string ``
|
|
||||||
KubeToken string `envconfig:"KUBERNETES_TOKEN"`
|
|
||||||
SkipTLSVerify bool `envconfig:"SKIP_TLS_VERIFY"`
|
|
||||||
Certificate string `envconfig:"KUBERNETES_CERTIFICATE"`
|
|
||||||
APIServer string `envconfig:"API_SERVER"`
|
|
||||||
ServiceAccount string `envconfig:"SERVICE_ACCOUNT"` // Can't just use split_words; need envconfig to find the non-prefixed form
|
|
||||||
|
|
||||||
// Config specifically for `helm upgrade`
|
|
||||||
ChartVersion string `split_words:"true"` //
|
|
||||||
DryRun bool `split_words:"true"` // also available for `delete`
|
|
||||||
Wait bool `` //
|
|
||||||
ReuseValues bool `split_words:"true"` //
|
|
||||||
Timeout string `` //
|
|
||||||
Chart string `` // Also available for `lint`, in which case it must be a path to a chart directory
|
|
||||||
Release string ``
|
|
||||||
Force bool `` //
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type helmCommand string
|
// NewConfig creates a Config and reads environment variables into it, accounting for several possible formats.
|
||||||
|
func NewConfig(stdout, stderr io.Writer) (*Config, error) {
|
||||||
|
cfg := Config{
|
||||||
|
Stdout: stdout,
|
||||||
|
Stderr: stderr,
|
||||||
|
}
|
||||||
|
if err := envconfig.Process("plugin", &cfg); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
// helmCommand.Decode checks the given value against the list of known commands and generates a helpful error if the command is unknown.
|
prefix := cfg.Prefix
|
||||||
func (cmd *helmCommand) Decode(value string) error {
|
|
||||||
known := []string{"upgrade", "delete", "lint", "help"}
|
if err := envconfig.Process("", &cfg); err != nil {
|
||||||
for _, c := range known {
|
return nil, err
|
||||||
if value == c {
|
}
|
||||||
*cmd = helmCommand(value)
|
|
||||||
return nil
|
if prefix != "" {
|
||||||
|
if err := envconfig.Process(cfg.Prefix, &cfg); err != nil {
|
||||||
|
return nil, err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if value == "" {
|
if cfg.Debug && cfg.Stderr != nil {
|
||||||
return nil
|
cfg.logDebug()
|
||||||
}
|
}
|
||||||
known[len(known)-1] = fmt.Sprintf("or %s", known[len(known)-1])
|
|
||||||
return fmt.Errorf("unknown command '%s'. If specified, command must be %s",
|
return &cfg, nil
|
||||||
value, strings.Join(known, ", "))
|
}
|
||||||
|
|
||||||
|
func (cfg Config) logDebug() {
|
||||||
|
if cfg.KubeToken != "" {
|
||||||
|
cfg.KubeToken = "(redacted)"
|
||||||
|
}
|
||||||
|
fmt.Fprintf(cfg.Stderr, "Generated config: %+v\n", cfg)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,27 +2,179 @@ package helm
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"github.com/stretchr/testify/suite"
|
"github.com/stretchr/testify/suite"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
type ConfigTestSuite struct {
|
type ConfigTestSuite struct {
|
||||||
suite.Suite
|
suite.Suite
|
||||||
|
// These tests need to mutate the environment, so the suite.setenv and .unsetenv functions store the original contents of the
|
||||||
|
// relevant variable in this map. Its use of *string is so they can distinguish between "not set" and "set to empty string"
|
||||||
|
envBackup map[string]*string
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestConfigTestSuite(t *testing.T) {
|
func TestConfigTestSuite(t *testing.T) {
|
||||||
suite.Run(t, new(ConfigTestSuite))
|
suite.Run(t, new(ConfigTestSuite))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (suite *ConfigTestSuite) TestHelmCommandDecodeSuccess() {
|
func (suite *ConfigTestSuite) TestNewConfigWithPluginPrefix() {
|
||||||
cmd := helmCommand("")
|
suite.unsetenv("PLUGIN_PREFIX")
|
||||||
err := cmd.Decode("upgrade")
|
suite.unsetenv("HELM_COMMAND")
|
||||||
suite.Require().Nil(err)
|
suite.unsetenv("UPDATE_DEPENDENCIES")
|
||||||
|
suite.unsetenv("DEBUG")
|
||||||
|
|
||||||
suite.EqualValues(cmd, "upgrade")
|
suite.setenv("PLUGIN_HELM_COMMAND", "execute order 66")
|
||||||
|
suite.setenv("PLUGIN_UPDATE_DEPENDENCIES", "true")
|
||||||
|
suite.setenv("PLUGIN_DEBUG", "true")
|
||||||
|
|
||||||
|
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||||
|
suite.Require().NoError(err)
|
||||||
|
|
||||||
|
suite.Equal("execute order 66", cfg.Command)
|
||||||
|
suite.True(cfg.UpdateDependencies)
|
||||||
|
suite.True(cfg.Debug)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (suite *ConfigTestSuite) TestHelmCommandDecodeFailure() {
|
func (suite *ConfigTestSuite) TestNewConfigWithNoPrefix() {
|
||||||
cmd := helmCommand("")
|
suite.unsetenv("PLUGIN_PREFIX")
|
||||||
err := cmd.Decode("execute order 66")
|
suite.unsetenv("PLUGIN_HELM_COMMAND")
|
||||||
suite.EqualError(err, "unknown command 'execute order 66'. If specified, command must be upgrade, delete, lint, or help")
|
suite.unsetenv("PLUGIN_UPDATE_DEPENDENCIES")
|
||||||
|
suite.unsetenv("PLUGIN_DEBUG")
|
||||||
|
|
||||||
|
suite.setenv("HELM_COMMAND", "execute order 66")
|
||||||
|
suite.setenv("UPDATE_DEPENDENCIES", "true")
|
||||||
|
suite.setenv("DEBUG", "true")
|
||||||
|
|
||||||
|
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||||
|
suite.Require().NoError(err)
|
||||||
|
|
||||||
|
suite.Equal("execute order 66", cfg.Command)
|
||||||
|
suite.True(cfg.UpdateDependencies)
|
||||||
|
suite.True(cfg.Debug)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) TestNewConfigWithConfigurablePrefix() {
|
||||||
|
suite.unsetenv("API_SERVER")
|
||||||
|
suite.unsetenv("PLUGIN_API_SERVER")
|
||||||
|
|
||||||
|
suite.setenv("PLUGIN_PREFIX", "prix_fixe")
|
||||||
|
suite.setenv("PRIX_FIXE_API_SERVER", "your waiter this evening")
|
||||||
|
|
||||||
|
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||||
|
suite.Require().NoError(err)
|
||||||
|
|
||||||
|
suite.Equal("prix_fixe", cfg.Prefix)
|
||||||
|
suite.Equal("your waiter this evening", cfg.APIServer)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) TestPrefixSettingDoesNotAffectPluginPrefix() {
|
||||||
|
suite.setenv("PLUGIN_PREFIX", "IXFREP")
|
||||||
|
suite.setenv("PLUGIN_HELM_COMMAND", "wake me up")
|
||||||
|
suite.setenv("IXFREP_PLUGIN_HELM_COMMAND", "send me to sleep inside")
|
||||||
|
|
||||||
|
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||||
|
suite.Require().NoError(err)
|
||||||
|
|
||||||
|
suite.Equal("wake me up", cfg.Command)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) TestPrefixSettingMustHavePluginPrefix() {
|
||||||
|
suite.unsetenv("PLUGIN_PREFIX")
|
||||||
|
suite.setenv("PREFIX", "refpix")
|
||||||
|
suite.setenv("HELM_COMMAND", "gimme more")
|
||||||
|
suite.setenv("REFPIX_HELM_COMMAND", "gimme less")
|
||||||
|
|
||||||
|
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||||
|
suite.Require().NoError(err)
|
||||||
|
|
||||||
|
suite.Equal("gimme more", cfg.Command)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) TestNewConfigWithConflictingVariables() {
|
||||||
|
suite.setenv("PLUGIN_HELM_COMMAND", "execute order 66")
|
||||||
|
suite.setenv("HELM_COMMAND", "defend the jedi") // values from the `environment` block override those from `settings`
|
||||||
|
|
||||||
|
suite.setenv("PLUGIN_PREFIX", "prod")
|
||||||
|
suite.setenv("TIMEOUT", "5m0s")
|
||||||
|
suite.setenv("PROD_TIMEOUT", "2m30s") // values from prefixed env vars override those from non-prefixed ones
|
||||||
|
|
||||||
|
cfg, err := NewConfig(&strings.Builder{}, &strings.Builder{})
|
||||||
|
suite.Require().NoError(err)
|
||||||
|
|
||||||
|
suite.Equal("defend the jedi", cfg.Command)
|
||||||
|
suite.Equal("2m30s", cfg.Timeout)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) TestNewConfigSetsWriters() {
|
||||||
|
stdout := &strings.Builder{}
|
||||||
|
stderr := &strings.Builder{}
|
||||||
|
cfg, err := NewConfig(stdout, stderr)
|
||||||
|
suite.Require().NoError(err)
|
||||||
|
|
||||||
|
suite.Equal(stdout, cfg.Stdout)
|
||||||
|
suite.Equal(stderr, cfg.Stderr)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) TestLogDebug() {
|
||||||
|
suite.setenv("DEBUG", "true")
|
||||||
|
suite.setenv("HELM_COMMAND", "upgrade")
|
||||||
|
|
||||||
|
stderr := strings.Builder{}
|
||||||
|
stdout := strings.Builder{}
|
||||||
|
_, err := NewConfig(&stdout, &stderr)
|
||||||
|
suite.Require().NoError(err)
|
||||||
|
|
||||||
|
suite.Equal("", stdout.String())
|
||||||
|
|
||||||
|
suite.Regexp(`^Generated config: \{Command:upgrade.*\}`, stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) TestLogDebugCensorsKubeToken() {
|
||||||
|
stderr := &strings.Builder{}
|
||||||
|
kubeToken := "I'm shy! Don't put me in your build logs!"
|
||||||
|
cfg := Config{
|
||||||
|
Debug: true,
|
||||||
|
KubeToken: kubeToken,
|
||||||
|
Stderr: stderr,
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg.logDebug()
|
||||||
|
|
||||||
|
suite.Contains(stderr.String(), "KubeToken:(redacted)")
|
||||||
|
suite.Equal(kubeToken, cfg.KubeToken) // The actual config value should be left unchanged
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) setenv(key, val string) {
|
||||||
|
orig, ok := os.LookupEnv(key)
|
||||||
|
if ok {
|
||||||
|
suite.envBackup[key] = &orig
|
||||||
|
} else {
|
||||||
|
suite.envBackup[key] = nil
|
||||||
|
}
|
||||||
|
os.Setenv(key, val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) unsetenv(key string) {
|
||||||
|
orig, ok := os.LookupEnv(key)
|
||||||
|
if ok {
|
||||||
|
suite.envBackup[key] = &orig
|
||||||
|
} else {
|
||||||
|
suite.envBackup[key] = nil
|
||||||
|
}
|
||||||
|
os.Unsetenv(key)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) BeforeTest(_, _ string) {
|
||||||
|
suite.envBackup = make(map[string]*string)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *ConfigTestSuite) AfterTest(_, _ string) {
|
||||||
|
for key, val := range suite.envBackup {
|
||||||
|
if val == nil {
|
||||||
|
os.Unsetenv(key)
|
||||||
|
} else {
|
||||||
|
os.Setenv(key, *val)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,7 +6,10 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
)
|
)
|
||||||
|
|
||||||
const kubeConfigTemplate = "/root/.kube/config.tpl"
|
const (
|
||||||
|
kubeConfigTemplate = "/root/.kube/config.tpl"
|
||||||
|
kubeConfigFile = "/root/.kube/config"
|
||||||
|
)
|
||||||
|
|
||||||
// A Step is one step in the plan.
|
// A Step is one step in the plan.
|
||||||
type Step interface {
|
type Step interface {
|
||||||
@@ -27,13 +30,12 @@ func NewPlan(cfg Config) (*Plan, error) {
|
|||||||
cfg: cfg,
|
cfg: cfg,
|
||||||
runCfg: run.Config{
|
runCfg: run.Config{
|
||||||
Debug: cfg.Debug,
|
Debug: cfg.Debug,
|
||||||
KubeConfig: cfg.KubeConfig,
|
|
||||||
Values: cfg.Values,
|
Values: cfg.Values,
|
||||||
StringValues: cfg.StringValues,
|
StringValues: cfg.StringValues,
|
||||||
ValuesFiles: cfg.ValuesFiles,
|
ValuesFiles: cfg.ValuesFiles,
|
||||||
Namespace: cfg.Namespace,
|
Namespace: cfg.Namespace,
|
||||||
Stdout: os.Stdout,
|
Stdout: cfg.Stdout,
|
||||||
Stderr: os.Stderr,
|
Stderr: cfg.Stderr,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -59,8 +61,8 @@ func determineSteps(cfg Config) *func(Config) []Step {
|
|||||||
switch cfg.Command {
|
switch cfg.Command {
|
||||||
case "upgrade":
|
case "upgrade":
|
||||||
return &upgrade
|
return &upgrade
|
||||||
case "delete":
|
case "uninstall", "delete":
|
||||||
panic("not implemented")
|
return &uninstall
|
||||||
case "lint":
|
case "lint":
|
||||||
return &lint
|
return &lint
|
||||||
case "help":
|
case "help":
|
||||||
@@ -69,6 +71,8 @@ func determineSteps(cfg Config) *func(Config) []Step {
|
|||||||
switch cfg.DroneEvent {
|
switch cfg.DroneEvent {
|
||||||
case "push", "tag", "deployment", "pull_request", "promote", "rollback":
|
case "push", "tag", "deployment", "pull_request", "promote", "rollback":
|
||||||
return &upgrade
|
return &upgrade
|
||||||
|
case "delete":
|
||||||
|
return &uninstall
|
||||||
default:
|
default:
|
||||||
panic("not implemented")
|
panic("not implemented")
|
||||||
}
|
}
|
||||||
@@ -79,11 +83,11 @@ func determineSteps(cfg Config) *func(Config) []Step {
|
|||||||
func (p *Plan) Execute() error {
|
func (p *Plan) Execute() error {
|
||||||
for i, step := range p.steps {
|
for i, step := range p.steps {
|
||||||
if p.cfg.Debug {
|
if p.cfg.Debug {
|
||||||
fmt.Fprintf(os.Stderr, "calling %T.Execute (step %d)\n", step, i)
|
fmt.Fprintf(p.cfg.Stderr, "calling %T.Execute (step %d)\n", step, i)
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := step.Execute(p.runCfg); err != nil {
|
if err := step.Execute(p.runCfg); err != nil {
|
||||||
return fmt.Errorf("in execution step %d: %w", i, err)
|
return fmt.Errorf("while executing %T step: %w", step, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -91,16 +95,7 @@ func (p *Plan) Execute() error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
var upgrade = func(cfg Config) []Step {
|
var upgrade = func(cfg Config) []Step {
|
||||||
steps := make([]Step, 0)
|
steps := initKube(cfg)
|
||||||
|
|
||||||
steps = append(steps, &run.InitKube{
|
|
||||||
SkipTLSVerify: cfg.SkipTLSVerify,
|
|
||||||
Certificate: cfg.Certificate,
|
|
||||||
APIServer: cfg.APIServer,
|
|
||||||
ServiceAccount: cfg.ServiceAccount,
|
|
||||||
Token: cfg.KubeToken,
|
|
||||||
TemplateFile: kubeConfigTemplate,
|
|
||||||
})
|
|
||||||
|
|
||||||
steps = append(steps, &run.Upgrade{
|
steps = append(steps, &run.Upgrade{
|
||||||
Chart: cfg.Chart,
|
Chart: cfg.Chart,
|
||||||
@@ -116,6 +111,16 @@ var upgrade = func(cfg Config) []Step {
|
|||||||
return steps
|
return steps
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var uninstall = func(cfg Config) []Step {
|
||||||
|
steps := initKube(cfg)
|
||||||
|
steps = append(steps, &run.Uninstall{
|
||||||
|
Release: cfg.Release,
|
||||||
|
DryRun: cfg.DryRun,
|
||||||
|
})
|
||||||
|
|
||||||
|
return steps
|
||||||
|
}
|
||||||
|
|
||||||
var lint = func(cfg Config) []Step {
|
var lint = func(cfg Config) []Step {
|
||||||
lint := &run.Lint{
|
lint := &run.Lint{
|
||||||
Chart: cfg.Chart,
|
Chart: cfg.Chart,
|
||||||
@@ -128,3 +133,19 @@ var help = func(cfg Config) []Step {
|
|||||||
help := &run.Help{}
|
help := &run.Help{}
|
||||||
return []Step{help}
|
return []Step{help}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func initKube(cfg Config) []Step {
|
||||||
|
return []Step{
|
||||||
|
&run.InitKube{
|
||||||
|
SkipTLSVerify: cfg.SkipTLSVerify,
|
||||||
|
Certificate: cfg.Certificate,
|
||||||
|
APIServer: cfg.APIServer,
|
||||||
|
ServiceAccount: cfg.ServiceAccount,
|
||||||
|
Token: cfg.KubeToken,
|
||||||
|
EKSCluster: cfg.EKSCluster,
|
||||||
|
EKSRoleARN: cfg.EKSRoleARN,
|
||||||
|
TemplateFile: kubeConfigTemplate,
|
||||||
|
ConfigFile: kubeConfigFile,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"github.com/golang/mock/gomock"
|
"github.com/golang/mock/gomock"
|
||||||
"github.com/stretchr/testify/suite"
|
"github.com/stretchr/testify/suite"
|
||||||
"os"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/pelotech/drone-helm3/internal/run"
|
"github.com/pelotech/drone-helm3/internal/run"
|
||||||
@@ -20,6 +20,7 @@ func TestPlanTestSuite(t *testing.T) {
|
|||||||
|
|
||||||
func (suite *PlanTestSuite) TestNewPlan() {
|
func (suite *PlanTestSuite) TestNewPlan() {
|
||||||
ctrl := gomock.NewController(suite.T())
|
ctrl := gomock.NewController(suite.T())
|
||||||
|
defer ctrl.Finish()
|
||||||
stepOne := NewMockStep(ctrl)
|
stepOne := NewMockStep(ctrl)
|
||||||
stepTwo := NewMockStep(ctrl)
|
stepTwo := NewMockStep(ctrl)
|
||||||
|
|
||||||
@@ -29,25 +30,27 @@ func (suite *PlanTestSuite) TestNewPlan() {
|
|||||||
}
|
}
|
||||||
defer func() { help = origHelp }()
|
defer func() { help = origHelp }()
|
||||||
|
|
||||||
|
stdout := strings.Builder{}
|
||||||
|
stderr := strings.Builder{}
|
||||||
cfg := Config{
|
cfg := Config{
|
||||||
Command: "help",
|
Command: "help",
|
||||||
Debug: false,
|
Debug: false,
|
||||||
KubeConfig: "/branch/.sfere/profig",
|
|
||||||
Values: "steadfastness,forthrightness",
|
Values: "steadfastness,forthrightness",
|
||||||
StringValues: "tensile_strength,flexibility",
|
StringValues: "tensile_strength,flexibility",
|
||||||
ValuesFiles: []string{"/root/price_inventory.yml"},
|
ValuesFiles: []string{"/root/price_inventory.yml"},
|
||||||
Namespace: "outer",
|
Namespace: "outer",
|
||||||
|
Stdout: &stdout,
|
||||||
|
Stderr: &stderr,
|
||||||
}
|
}
|
||||||
|
|
||||||
runCfg := run.Config{
|
runCfg := run.Config{
|
||||||
Debug: false,
|
Debug: false,
|
||||||
KubeConfig: "/branch/.sfere/profig",
|
|
||||||
Values: "steadfastness,forthrightness",
|
Values: "steadfastness,forthrightness",
|
||||||
StringValues: "tensile_strength,flexibility",
|
StringValues: "tensile_strength,flexibility",
|
||||||
ValuesFiles: []string{"/root/price_inventory.yml"},
|
ValuesFiles: []string{"/root/price_inventory.yml"},
|
||||||
Namespace: "outer",
|
Namespace: "outer",
|
||||||
Stdout: os.Stdout,
|
Stdout: &stdout,
|
||||||
Stderr: os.Stderr,
|
Stderr: &stderr,
|
||||||
}
|
}
|
||||||
|
|
||||||
stepOne.EXPECT().
|
stepOne.EXPECT().
|
||||||
@@ -63,6 +66,7 @@ func (suite *PlanTestSuite) TestNewPlan() {
|
|||||||
|
|
||||||
func (suite *PlanTestSuite) TestNewPlanAbortsOnError() {
|
func (suite *PlanTestSuite) TestNewPlanAbortsOnError() {
|
||||||
ctrl := gomock.NewController(suite.T())
|
ctrl := gomock.NewController(suite.T())
|
||||||
|
defer ctrl.Finish()
|
||||||
stepOne := NewMockStep(ctrl)
|
stepOne := NewMockStep(ctrl)
|
||||||
stepTwo := NewMockStep(ctrl)
|
stepTwo := NewMockStep(ctrl)
|
||||||
|
|
||||||
@@ -85,13 +89,53 @@ func (suite *PlanTestSuite) TestNewPlanAbortsOnError() {
|
|||||||
suite.EqualError(err, "while preparing *helm.MockStep step: I'm starry Dave, aye, cat blew that")
|
suite.EqualError(err, "while preparing *helm.MockStep step: I'm starry Dave, aye, cat blew that")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (suite *PlanTestSuite) TestExecute() {
|
||||||
|
ctrl := gomock.NewController(suite.T())
|
||||||
|
defer ctrl.Finish()
|
||||||
|
stepOne := NewMockStep(ctrl)
|
||||||
|
stepTwo := NewMockStep(ctrl)
|
||||||
|
|
||||||
|
runCfg := run.Config{}
|
||||||
|
|
||||||
|
plan := Plan{
|
||||||
|
steps: []Step{stepOne, stepTwo},
|
||||||
|
runCfg: runCfg,
|
||||||
|
}
|
||||||
|
|
||||||
|
stepOne.EXPECT().
|
||||||
|
Execute(runCfg).
|
||||||
|
Times(1)
|
||||||
|
stepTwo.EXPECT().
|
||||||
|
Execute(runCfg).
|
||||||
|
Times(1)
|
||||||
|
|
||||||
|
suite.NoError(plan.Execute())
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *PlanTestSuite) TestExecuteAbortsOnError() {
|
||||||
|
ctrl := gomock.NewController(suite.T())
|
||||||
|
defer ctrl.Finish()
|
||||||
|
stepOne := NewMockStep(ctrl)
|
||||||
|
stepTwo := NewMockStep(ctrl)
|
||||||
|
|
||||||
|
runCfg := run.Config{}
|
||||||
|
|
||||||
|
plan := Plan{
|
||||||
|
steps: []Step{stepOne, stepTwo},
|
||||||
|
runCfg: runCfg,
|
||||||
|
}
|
||||||
|
|
||||||
|
stepOne.EXPECT().
|
||||||
|
Execute(runCfg).
|
||||||
|
Times(1).
|
||||||
|
Return(fmt.Errorf("oh, he'll gnaw"))
|
||||||
|
|
||||||
|
err := plan.Execute()
|
||||||
|
suite.EqualError(err, "while executing *helm.MockStep step: oh, he'll gnaw")
|
||||||
|
}
|
||||||
|
|
||||||
func (suite *PlanTestSuite) TestUpgrade() {
|
func (suite *PlanTestSuite) TestUpgrade() {
|
||||||
cfg := Config{
|
cfg := Config{
|
||||||
KubeToken: "cXVlZXIgY2hhcmFjdGVyCg==",
|
|
||||||
SkipTLSVerify: true,
|
|
||||||
Certificate: "b2Ygd29rZW5lc3MK",
|
|
||||||
APIServer: "123.456.78.9",
|
|
||||||
ServiceAccount: "helmet",
|
|
||||||
ChartVersion: "seventeen",
|
ChartVersion: "seventeen",
|
||||||
DryRun: true,
|
DryRun: true,
|
||||||
Wait: true,
|
Wait: true,
|
||||||
@@ -103,27 +147,13 @@ func (suite *PlanTestSuite) TestUpgrade() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
steps := upgrade(cfg)
|
steps := upgrade(cfg)
|
||||||
|
suite.Require().Equal(2, len(steps), "upgrade should return 2 steps")
|
||||||
suite.Equal(2, len(steps))
|
|
||||||
|
|
||||||
suite.Require().IsType(&run.InitKube{}, steps[0])
|
suite.Require().IsType(&run.InitKube{}, steps[0])
|
||||||
init, _ := steps[0].(*run.InitKube)
|
|
||||||
|
|
||||||
var expected Step = &run.InitKube{
|
|
||||||
SkipTLSVerify: cfg.SkipTLSVerify,
|
|
||||||
Certificate: cfg.Certificate,
|
|
||||||
APIServer: cfg.APIServer,
|
|
||||||
ServiceAccount: cfg.ServiceAccount,
|
|
||||||
Token: cfg.KubeToken,
|
|
||||||
TemplateFile: kubeConfigTemplate,
|
|
||||||
}
|
|
||||||
|
|
||||||
suite.Equal(expected, init)
|
|
||||||
|
|
||||||
suite.Require().IsType(&run.Upgrade{}, steps[1])
|
suite.Require().IsType(&run.Upgrade{}, steps[1])
|
||||||
upgrade, _ := steps[1].(*run.Upgrade)
|
upgrade, _ := steps[1].(*run.Upgrade)
|
||||||
|
|
||||||
expected = &run.Upgrade{
|
expected := &run.Upgrade{
|
||||||
Chart: cfg.Chart,
|
Chart: cfg.Chart,
|
||||||
Release: cfg.Release,
|
Release: cfg.Release,
|
||||||
ChartVersion: cfg.ChartVersion,
|
ChartVersion: cfg.ChartVersion,
|
||||||
@@ -137,6 +167,74 @@ func (suite *PlanTestSuite) TestUpgrade() {
|
|||||||
suite.Equal(expected, upgrade)
|
suite.Equal(expected, upgrade)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (suite *PlanTestSuite) TestDel() {
|
||||||
|
cfg := Config{
|
||||||
|
KubeToken: "b2YgbXkgYWZmZWN0aW9u",
|
||||||
|
SkipTLSVerify: true,
|
||||||
|
Certificate: "cHJvY2xhaW1zIHdvbmRlcmZ1bCBmcmllbmRzaGlw",
|
||||||
|
APIServer: "98.765.43.21",
|
||||||
|
ServiceAccount: "greathelm",
|
||||||
|
DryRun: true,
|
||||||
|
Timeout: "think about what you did",
|
||||||
|
Release: "jetta_id_love_to_change_the_world",
|
||||||
|
}
|
||||||
|
|
||||||
|
steps := uninstall(cfg)
|
||||||
|
suite.Require().Equal(2, len(steps), "uninstall should return 2 steps")
|
||||||
|
|
||||||
|
suite.Require().IsType(&run.InitKube{}, steps[0])
|
||||||
|
init, _ := steps[0].(*run.InitKube)
|
||||||
|
var expected Step = &run.InitKube{
|
||||||
|
SkipTLSVerify: true,
|
||||||
|
Certificate: "cHJvY2xhaW1zIHdvbmRlcmZ1bCBmcmllbmRzaGlw",
|
||||||
|
APIServer: "98.765.43.21",
|
||||||
|
ServiceAccount: "greathelm",
|
||||||
|
Token: "b2YgbXkgYWZmZWN0aW9u",
|
||||||
|
TemplateFile: kubeConfigTemplate,
|
||||||
|
ConfigFile: kubeConfigFile,
|
||||||
|
}
|
||||||
|
|
||||||
|
suite.Equal(expected, init)
|
||||||
|
|
||||||
|
suite.Require().IsType(&run.Uninstall{}, steps[1])
|
||||||
|
actual, _ := steps[1].(*run.Uninstall)
|
||||||
|
expected = &run.Uninstall{
|
||||||
|
Release: "jetta_id_love_to_change_the_world",
|
||||||
|
DryRun: true,
|
||||||
|
}
|
||||||
|
suite.Equal(expected, actual)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *PlanTestSuite) TestInitKube() {
|
||||||
|
cfg := Config{
|
||||||
|
KubeToken: "cXVlZXIgY2hhcmFjdGVyCg==",
|
||||||
|
SkipTLSVerify: true,
|
||||||
|
Certificate: "b2Ygd29rZW5lc3MK",
|
||||||
|
APIServer: "123.456.78.9",
|
||||||
|
ServiceAccount: "helmet",
|
||||||
|
EKSCluster: "eks_reader",
|
||||||
|
EKSRoleARN: "arn:aws:iam::9631085:role/eksSpangleRole",
|
||||||
|
}
|
||||||
|
|
||||||
|
steps := initKube(cfg)
|
||||||
|
suite.Require().Equal(1, len(steps), "initKube should return one step")
|
||||||
|
suite.Require().IsType(&run.InitKube{}, steps[0])
|
||||||
|
init, _ := steps[0].(*run.InitKube)
|
||||||
|
|
||||||
|
expected := &run.InitKube{
|
||||||
|
SkipTLSVerify: true,
|
||||||
|
Certificate: "b2Ygd29rZW5lc3MK",
|
||||||
|
APIServer: "123.456.78.9",
|
||||||
|
ServiceAccount: "helmet",
|
||||||
|
Token: "cXVlZXIgY2hhcmFjdGVyCg==",
|
||||||
|
EKSCluster: "eks_reader",
|
||||||
|
EKSRoleARN: "arn:aws:iam::9631085:role/eksSpangleRole",
|
||||||
|
TemplateFile: kubeConfigTemplate,
|
||||||
|
ConfigFile: kubeConfigFile,
|
||||||
|
}
|
||||||
|
suite.Equal(expected, init)
|
||||||
|
}
|
||||||
|
|
||||||
func (suite *PlanTestSuite) TestLint() {
|
func (suite *PlanTestSuite) TestLint() {
|
||||||
cfg := Config{
|
cfg := Config{
|
||||||
Chart: "./flow",
|
Chart: "./flow",
|
||||||
@@ -170,6 +268,31 @@ func (suite *PlanTestSuite) TestDeterminePlanUpgradeFromDroneEvent() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (suite *PlanTestSuite) TestDeterminePlanUninstallCommand() {
|
||||||
|
cfg := Config{
|
||||||
|
Command: "uninstall",
|
||||||
|
}
|
||||||
|
stepsMaker := determineSteps(cfg)
|
||||||
|
suite.Same(&uninstall, stepsMaker)
|
||||||
|
}
|
||||||
|
|
||||||
|
// helm_command = delete is provided as an alias for backwards-compatibility with drone-helm
|
||||||
|
func (suite *PlanTestSuite) TestDeterminePlanDeleteCommand() {
|
||||||
|
cfg := Config{
|
||||||
|
Command: "delete",
|
||||||
|
}
|
||||||
|
stepsMaker := determineSteps(cfg)
|
||||||
|
suite.Same(&uninstall, stepsMaker)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *PlanTestSuite) TestDeterminePlanDeleteFromDroneEvent() {
|
||||||
|
cfg := Config{
|
||||||
|
DroneEvent: "delete",
|
||||||
|
}
|
||||||
|
stepsMaker := determineSteps(cfg)
|
||||||
|
suite.Same(&uninstall, stepsMaker)
|
||||||
|
}
|
||||||
|
|
||||||
func (suite *PlanTestSuite) TestDeterminePlanLintCommand() {
|
func (suite *PlanTestSuite) TestDeterminePlanLintCommand() {
|
||||||
cfg := Config{
|
cfg := Config{
|
||||||
Command: "lint",
|
Command: "lint",
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ import (
|
|||||||
// Config contains configuration applicable to all helm commands
|
// Config contains configuration applicable to all helm commands
|
||||||
type Config struct {
|
type Config struct {
|
||||||
Debug bool
|
Debug bool
|
||||||
KubeConfig string
|
|
||||||
Values string
|
Values string
|
||||||
StringValues string
|
StringValues string
|
||||||
ValuesFiles []string
|
ValuesFiles []string
|
||||||
|
|||||||
@@ -15,7 +15,10 @@ type InitKube struct {
|
|||||||
APIServer string
|
APIServer string
|
||||||
ServiceAccount string
|
ServiceAccount string
|
||||||
Token string
|
Token string
|
||||||
|
EKSCluster string
|
||||||
|
EKSRoleARN string
|
||||||
TemplateFile string
|
TemplateFile string
|
||||||
|
ConfigFile string
|
||||||
|
|
||||||
template *template.Template
|
template *template.Template
|
||||||
configFile io.WriteCloser
|
configFile io.WriteCloser
|
||||||
@@ -29,12 +32,14 @@ type kubeValues struct {
|
|||||||
Namespace string
|
Namespace string
|
||||||
ServiceAccount string
|
ServiceAccount string
|
||||||
Token string
|
Token string
|
||||||
|
EKSCluster string
|
||||||
|
EKSRoleARN string
|
||||||
}
|
}
|
||||||
|
|
||||||
// Execute generates a kubernetes config file from drone-helm3's template.
|
// Execute generates a kubernetes config file from drone-helm3's template.
|
||||||
func (i *InitKube) Execute(cfg Config) error {
|
func (i *InitKube) Execute(cfg Config) error {
|
||||||
if cfg.Debug {
|
if cfg.Debug {
|
||||||
fmt.Fprintf(cfg.Stderr, "writing kubeconfig file to %s\n", cfg.KubeConfig)
|
fmt.Fprintf(cfg.Stderr, "writing kubeconfig file to %s\n", i.ConfigFile)
|
||||||
}
|
}
|
||||||
defer i.configFile.Close()
|
defer i.configFile.Close()
|
||||||
return i.template.Execute(i.configFile, i.values)
|
return i.template.Execute(i.configFile, i.values)
|
||||||
@@ -47,11 +52,11 @@ func (i *InitKube) Prepare(cfg Config) error {
|
|||||||
if i.APIServer == "" {
|
if i.APIServer == "" {
|
||||||
return errors.New("an API Server is needed to deploy")
|
return errors.New("an API Server is needed to deploy")
|
||||||
}
|
}
|
||||||
if i.Token == "" {
|
if i.Token == "" && i.EKSCluster == "" {
|
||||||
return errors.New("token is needed to deploy")
|
return errors.New("token is needed to deploy")
|
||||||
}
|
}
|
||||||
if i.Certificate == "" && !i.SkipTLSVerify {
|
if i.Token != "" && i.EKSCluster != "" {
|
||||||
return errors.New("certificate is needed to deploy")
|
return errors.New("token cannot be used simultaneously with eksCluster")
|
||||||
}
|
}
|
||||||
|
|
||||||
if i.ServiceAccount == "" {
|
if i.ServiceAccount == "" {
|
||||||
@@ -72,20 +77,22 @@ func (i *InitKube) Prepare(cfg Config) error {
|
|||||||
APIServer: i.APIServer,
|
APIServer: i.APIServer,
|
||||||
ServiceAccount: i.ServiceAccount,
|
ServiceAccount: i.ServiceAccount,
|
||||||
Token: i.Token,
|
Token: i.Token,
|
||||||
|
EKSCluster: i.EKSCluster,
|
||||||
|
EKSRoleARN: i.EKSRoleARN,
|
||||||
Namespace: cfg.Namespace,
|
Namespace: cfg.Namespace,
|
||||||
}
|
}
|
||||||
|
|
||||||
if cfg.Debug {
|
if cfg.Debug {
|
||||||
if _, err := os.Stat(cfg.KubeConfig); err != nil {
|
if _, err := os.Stat(i.ConfigFile); err != nil {
|
||||||
// non-nil err here isn't an actual error state; the kubeconfig just doesn't exist
|
// non-nil err here isn't an actual error state; the kubeconfig just doesn't exist
|
||||||
fmt.Fprint(cfg.Stderr, "creating ")
|
fmt.Fprint(cfg.Stderr, "creating ")
|
||||||
} else {
|
} else {
|
||||||
fmt.Fprint(cfg.Stderr, "truncating ")
|
fmt.Fprint(cfg.Stderr, "truncating ")
|
||||||
}
|
}
|
||||||
fmt.Fprintf(cfg.Stderr, "kubeconfig file at %s\n", cfg.KubeConfig)
|
fmt.Fprintf(cfg.Stderr, "kubeconfig file at %s\n", i.ConfigFile)
|
||||||
}
|
}
|
||||||
|
|
||||||
i.configFile, err = os.Create(cfg.KubeConfig)
|
i.configFile, err = os.Create(i.ConfigFile)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("could not open kubeconfig file for writing: %w", err)
|
return fmt.Errorf("could not open kubeconfig file for writing: %w", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,12 +1,11 @@
|
|||||||
package run
|
package run
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"github.com/stretchr/testify/suite"
|
||||||
"io/ioutil"
|
"io/ioutil"
|
||||||
"os"
|
"os"
|
||||||
"text/template"
|
|
||||||
// "github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/suite"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
"text/template"
|
||||||
)
|
)
|
||||||
|
|
||||||
type InitKubeTestSuite struct {
|
type InitKubeTestSuite struct {
|
||||||
@@ -34,10 +33,10 @@ namespace: {{ .Namespace }}
|
|||||||
Certificate: "CCNA",
|
Certificate: "CCNA",
|
||||||
Token: "Aspire virtual currency",
|
Token: "Aspire virtual currency",
|
||||||
TemplateFile: templateFile.Name(),
|
TemplateFile: templateFile.Name(),
|
||||||
|
ConfigFile: configFile.Name(),
|
||||||
}
|
}
|
||||||
cfg := Config{
|
cfg := Config{
|
||||||
Namespace: "Cisco",
|
Namespace: "Cisco",
|
||||||
KubeConfig: configFile.Name(),
|
|
||||||
}
|
}
|
||||||
err = init.Prepare(cfg)
|
err = init.Prepare(cfg)
|
||||||
suite.Require().Nil(err)
|
suite.Require().Nil(err)
|
||||||
@@ -95,11 +94,10 @@ func (suite *InitKubeTestSuite) TestPrepareCannotOpenDestinationFile() {
|
|||||||
Certificate: "CCNA",
|
Certificate: "CCNA",
|
||||||
Token: "Aspire virtual currency",
|
Token: "Aspire virtual currency",
|
||||||
TemplateFile: templateFile.Name(),
|
TemplateFile: templateFile.Name(),
|
||||||
|
ConfigFile: "/usr/foreign/exclude/kubeprofig",
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg := Config{
|
cfg := Config{}
|
||||||
KubeConfig: "/usr/foreign/exclude/kubeprofig",
|
|
||||||
}
|
|
||||||
err = init.Prepare(cfg)
|
err = init.Prepare(cfg)
|
||||||
suite.Error(err)
|
suite.Error(err)
|
||||||
suite.Regexp("could not open .* for writing: .* no such file or directory", err)
|
suite.Regexp("could not open .* for writing: .* no such file or directory", err)
|
||||||
@@ -120,11 +118,10 @@ func (suite *InitKubeTestSuite) TestPrepareRequiredConfig() {
|
|||||||
Certificate: "CCNA",
|
Certificate: "CCNA",
|
||||||
Token: "Aspire virtual currency",
|
Token: "Aspire virtual currency",
|
||||||
TemplateFile: templateFile.Name(),
|
TemplateFile: templateFile.Name(),
|
||||||
|
ConfigFile: configFile.Name(),
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg := Config{
|
cfg := Config{}
|
||||||
KubeConfig: configFile.Name(),
|
|
||||||
}
|
|
||||||
|
|
||||||
suite.NoError(init.Prepare(cfg)) // consistency check; we should be starting in a happy state
|
suite.NoError(init.Prepare(cfg)) // consistency check; we should be starting in a happy state
|
||||||
|
|
||||||
@@ -134,13 +131,33 @@ func (suite *InitKubeTestSuite) TestPrepareRequiredConfig() {
|
|||||||
init.APIServer = "Sysadmin"
|
init.APIServer = "Sysadmin"
|
||||||
init.Token = ""
|
init.Token = ""
|
||||||
suite.Error(init.Prepare(cfg), "Token should be required.")
|
suite.Error(init.Prepare(cfg), "Token should be required.")
|
||||||
|
}
|
||||||
|
|
||||||
init.Token = "Aspire virtual currency"
|
func (suite *InitKubeTestSuite) TestPrepareEKSConfig() {
|
||||||
init.Certificate = ""
|
templateFile, err := tempfile("kubeconfig********.yml.tpl", "hurgity burgity")
|
||||||
suite.Error(init.Prepare(cfg), "Certificate should be required.")
|
defer os.Remove(templateFile.Name())
|
||||||
|
suite.Require().Nil(err)
|
||||||
|
|
||||||
init.SkipTLSVerify = true
|
configFile, err := tempfile("kubeconfig********.yml", "")
|
||||||
suite.NoError(init.Prepare(cfg), "Certificate should not be required if SkipTLSVerify is true")
|
defer os.Remove(configFile.Name())
|
||||||
|
suite.Require().Nil(err)
|
||||||
|
|
||||||
|
init := InitKube{
|
||||||
|
TemplateFile: templateFile.Name(),
|
||||||
|
ConfigFile: configFile.Name(),
|
||||||
|
APIServer: "eks.aws.amazonaws.com",
|
||||||
|
EKSCluster: "it-is-an-eks-parrot",
|
||||||
|
EKSRoleARN: "arn:aws:iam::19691207:role/mrPraline",
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg := Config{}
|
||||||
|
|
||||||
|
suite.NoError(init.Prepare(cfg))
|
||||||
|
suite.Equal(init.values.EKSCluster, "it-is-an-eks-parrot")
|
||||||
|
suite.Equal(init.values.EKSRoleARN, "arn:aws:iam::19691207:role/mrPraline")
|
||||||
|
|
||||||
|
init.Token = "cGluaW5nIGZvciB0aGUgZmrDtnJkcw=="
|
||||||
|
suite.EqualError(init.Prepare(cfg), "token cannot be used simultaneously with eksCluster")
|
||||||
}
|
}
|
||||||
|
|
||||||
func (suite *InitKubeTestSuite) TestPrepareDefaultsServiceAccount() {
|
func (suite *InitKubeTestSuite) TestPrepareDefaultsServiceAccount() {
|
||||||
@@ -157,11 +174,10 @@ func (suite *InitKubeTestSuite) TestPrepareDefaultsServiceAccount() {
|
|||||||
Certificate: "CCNA",
|
Certificate: "CCNA",
|
||||||
Token: "Aspire virtual currency",
|
Token: "Aspire virtual currency",
|
||||||
TemplateFile: templateFile.Name(),
|
TemplateFile: templateFile.Name(),
|
||||||
|
ConfigFile: configFile.Name(),
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg := Config{
|
cfg := Config{}
|
||||||
KubeConfig: configFile.Name(),
|
|
||||||
}
|
|
||||||
|
|
||||||
init.Prepare(cfg)
|
init.Prepare(cfg)
|
||||||
suite.Equal("helm", init.ServiceAccount)
|
suite.Equal("helm", init.ServiceAccount)
|
||||||
|
|||||||
109
internal/run/kubeconfig_test.go
Normal file
109
internal/run/kubeconfig_test.go
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
package run
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/stretchr/testify/suite"
|
||||||
|
yaml "gopkg.in/yaml.v2"
|
||||||
|
"io/ioutil"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
type KubeconfigTestSuite struct {
|
||||||
|
suite.Suite
|
||||||
|
configFile *os.File
|
||||||
|
initKube InitKube
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) BeforeTest(_, _ string) {
|
||||||
|
file, err := ioutil.TempFile("", "kubeconfig********.yml")
|
||||||
|
suite.Require().NoError(err)
|
||||||
|
file.Close()
|
||||||
|
suite.configFile = file
|
||||||
|
|
||||||
|
// set up an InitKube with the bare minimum configuration
|
||||||
|
suite.initKube = InitKube{
|
||||||
|
ConfigFile: file.Name(),
|
||||||
|
TemplateFile: "../../assets/kubeconfig.tpl", // the actual kubeconfig template
|
||||||
|
APIServer: "a",
|
||||||
|
Token: "b",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) AfterTest(_, _ string) {
|
||||||
|
if suite.configFile != nil {
|
||||||
|
os.Remove(suite.configFile.Name())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestKubeconfigTestSuite(t *testing.T) {
|
||||||
|
suite.Run(t, new(KubeconfigTestSuite))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) TestSetsNamespace() {
|
||||||
|
cfg := Config{
|
||||||
|
Namespace: "marshmallow",
|
||||||
|
}
|
||||||
|
contents := suite.generateKubeconfig(cfg)
|
||||||
|
suite.Contains(contents, "namespace: marshmallow")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) TestSetsAPIServer() {
|
||||||
|
suite.initKube.APIServer = "https://kube.cluster/peanut"
|
||||||
|
contents := suite.generateKubeconfig(Config{})
|
||||||
|
suite.Contains(contents, "server: https://kube.cluster/peanut")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) TestSetsServiceAccount() {
|
||||||
|
suite.initKube.ServiceAccount = "chef"
|
||||||
|
contents := suite.generateKubeconfig(Config{})
|
||||||
|
suite.Contains(contents, "user: chef")
|
||||||
|
suite.Contains(contents, "name: chef")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) TestSetsToken() {
|
||||||
|
suite.initKube.Token = "eWVhaCB3ZSB0b2tpbic"
|
||||||
|
contents := suite.generateKubeconfig(Config{})
|
||||||
|
suite.Contains(contents, "token: eWVhaCB3ZSB0b2tpbic")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) TestSetsCertificate() {
|
||||||
|
suite.initKube.Certificate = "d293LCB5b3UgYXJlIHNvIGNvb2wgZm9yIHNtb2tpbmcgd2VlZCDwn5mE"
|
||||||
|
contents := suite.generateKubeconfig(Config{})
|
||||||
|
suite.Contains(contents, "certificate-authority-data: d293LCB5b3UgYXJlIHNvIGNvb2wgZm9yIHNtb2tpbmcgd2VlZCDwn5mE")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) TestSetsSkipTLSVerify() {
|
||||||
|
suite.initKube.SkipTLSVerify = true
|
||||||
|
contents := suite.generateKubeconfig(Config{})
|
||||||
|
suite.Contains(contents, "insecure-skip-tls-verify: true")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) TestSetsEKSCluster() {
|
||||||
|
suite.initKube.Token = ""
|
||||||
|
suite.initKube.EKSCluster = "it-is-an-eks-parrot"
|
||||||
|
contents := suite.generateKubeconfig(Config{})
|
||||||
|
suite.Contains(contents, "command: aws-iam-authenticator")
|
||||||
|
suite.Contains(contents, `- "it-is-an-eks-parrot"`)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) TestSetsEKSRoleARN() {
|
||||||
|
suite.initKube.Token = ""
|
||||||
|
suite.initKube.EKSCluster = "it-is-an-eks-parrot"
|
||||||
|
suite.initKube.EKSRoleARN = "arn:aws:iam::19691207:role/mrPraline"
|
||||||
|
contents := suite.generateKubeconfig(Config{})
|
||||||
|
suite.Contains(contents, `- "-r"`)
|
||||||
|
suite.Contains(contents, `- "arn:aws:iam::19691207:role/mrPraline"`)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *KubeconfigTestSuite) generateKubeconfig(cfg Config) string {
|
||||||
|
suite.Require().NoError(suite.initKube.Prepare(cfg))
|
||||||
|
suite.Require().NoError(suite.initKube.Execute(cfg))
|
||||||
|
|
||||||
|
contents, err := ioutil.ReadFile(suite.configFile.Name())
|
||||||
|
suite.Require().NoError(err)
|
||||||
|
|
||||||
|
conf := map[string]interface{}{}
|
||||||
|
suite.NoError(yaml.UnmarshalStrict(contents, &conf))
|
||||||
|
|
||||||
|
return string(contents)
|
||||||
|
}
|
||||||
51
internal/run/uninstall.go
Normal file
51
internal/run/uninstall.go
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
package run
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Uninstall is an execution step that calls `helm uninstall` when executed.
|
||||||
|
type Uninstall struct {
|
||||||
|
Release string
|
||||||
|
DryRun bool
|
||||||
|
cmd cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// Execute executes the `helm uninstall` command.
|
||||||
|
func (u *Uninstall) Execute(_ Config) error {
|
||||||
|
return u.cmd.Run()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Prepare gets the Uninstall ready to execute.
|
||||||
|
func (u *Uninstall) Prepare(cfg Config) error {
|
||||||
|
if u.Release == "" {
|
||||||
|
return fmt.Errorf("release is required")
|
||||||
|
}
|
||||||
|
|
||||||
|
args := make([]string, 0)
|
||||||
|
|
||||||
|
if cfg.Namespace != "" {
|
||||||
|
args = append(args, "--namespace", cfg.Namespace)
|
||||||
|
}
|
||||||
|
if cfg.Debug {
|
||||||
|
args = append(args, "--debug")
|
||||||
|
}
|
||||||
|
|
||||||
|
args = append(args, "uninstall")
|
||||||
|
|
||||||
|
if u.DryRun {
|
||||||
|
args = append(args, "--dry-run")
|
||||||
|
}
|
||||||
|
|
||||||
|
args = append(args, u.Release)
|
||||||
|
|
||||||
|
u.cmd = command(helmBin, args...)
|
||||||
|
u.cmd.Stdout(cfg.Stdout)
|
||||||
|
u.cmd.Stderr(cfg.Stderr)
|
||||||
|
|
||||||
|
if cfg.Debug {
|
||||||
|
fmt.Fprintf(cfg.Stderr, "Generated command: '%s'\n", u.cmd.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
134
internal/run/uninstall_test.go
Normal file
134
internal/run/uninstall_test.go
Normal file
@@ -0,0 +1,134 @@
|
|||||||
|
package run
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/golang/mock/gomock"
|
||||||
|
"github.com/stretchr/testify/suite"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
type UninstallTestSuite struct {
|
||||||
|
suite.Suite
|
||||||
|
ctrl *gomock.Controller
|
||||||
|
mockCmd *Mockcmd
|
||||||
|
actualArgs []string
|
||||||
|
originalCommand func(string, ...string) cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *UninstallTestSuite) BeforeTest(_, _ string) {
|
||||||
|
suite.ctrl = gomock.NewController(suite.T())
|
||||||
|
suite.mockCmd = NewMockcmd(suite.ctrl)
|
||||||
|
|
||||||
|
suite.originalCommand = command
|
||||||
|
command = func(path string, args ...string) cmd {
|
||||||
|
suite.actualArgs = args
|
||||||
|
return suite.mockCmd
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *UninstallTestSuite) AfterTest(_, _ string) {
|
||||||
|
command = suite.originalCommand
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUninstallTestSuite(t *testing.T) {
|
||||||
|
suite.Run(t, new(UninstallTestSuite))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *UninstallTestSuite) TestPrepareAndExecute() {
|
||||||
|
defer suite.ctrl.Finish()
|
||||||
|
|
||||||
|
u := Uninstall{
|
||||||
|
Release: "zayde_wølf_king",
|
||||||
|
}
|
||||||
|
|
||||||
|
actual := []string{}
|
||||||
|
command = func(path string, args ...string) cmd {
|
||||||
|
suite.Equal(helmBin, path)
|
||||||
|
actual = args
|
||||||
|
|
||||||
|
return suite.mockCmd
|
||||||
|
}
|
||||||
|
|
||||||
|
suite.mockCmd.EXPECT().
|
||||||
|
Stdout(gomock.Any())
|
||||||
|
suite.mockCmd.EXPECT().
|
||||||
|
Stderr(gomock.Any())
|
||||||
|
suite.mockCmd.EXPECT().
|
||||||
|
Run().
|
||||||
|
Times(1)
|
||||||
|
|
||||||
|
cfg := Config{}
|
||||||
|
suite.NoError(u.Prepare(cfg))
|
||||||
|
expected := []string{"uninstall", "zayde_wølf_king"}
|
||||||
|
suite.Equal(expected, actual)
|
||||||
|
|
||||||
|
u.Execute(cfg)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *UninstallTestSuite) TestPrepareDryRunFlag() {
|
||||||
|
u := Uninstall{
|
||||||
|
Release: "firefox_ak_wildfire",
|
||||||
|
DryRun: true,
|
||||||
|
}
|
||||||
|
cfg := Config{}
|
||||||
|
|
||||||
|
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||||
|
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||||
|
|
||||||
|
suite.NoError(u.Prepare(cfg))
|
||||||
|
expected := []string{"uninstall", "--dry-run", "firefox_ak_wildfire"}
|
||||||
|
suite.Equal(expected, suite.actualArgs)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *UninstallTestSuite) TestPrepareNamespaceFlag() {
|
||||||
|
u := Uninstall{
|
||||||
|
Release: "carly_simon_run_away_with_me",
|
||||||
|
}
|
||||||
|
cfg := Config{
|
||||||
|
Namespace: "emotion",
|
||||||
|
}
|
||||||
|
|
||||||
|
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||||
|
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||||
|
|
||||||
|
suite.NoError(u.Prepare(cfg))
|
||||||
|
expected := []string{"--namespace", "emotion", "uninstall", "carly_simon_run_away_with_me"}
|
||||||
|
suite.Equal(expected, suite.actualArgs)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *UninstallTestSuite) TestPrepareDebugFlag() {
|
||||||
|
u := Uninstall{
|
||||||
|
Release: "just_a_band_huff_and_puff",
|
||||||
|
}
|
||||||
|
stderr := strings.Builder{}
|
||||||
|
cfg := Config{
|
||||||
|
Debug: true,
|
||||||
|
Stderr: &stderr,
|
||||||
|
}
|
||||||
|
|
||||||
|
command = func(path string, args ...string) cmd {
|
||||||
|
suite.mockCmd.EXPECT().
|
||||||
|
String().
|
||||||
|
Return(fmt.Sprintf("%s %s", path, strings.Join(args, " ")))
|
||||||
|
|
||||||
|
return suite.mockCmd
|
||||||
|
}
|
||||||
|
|
||||||
|
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||||
|
suite.mockCmd.EXPECT().Stderr(&stderr).AnyTimes()
|
||||||
|
|
||||||
|
suite.NoError(u.Prepare(cfg))
|
||||||
|
suite.Equal(fmt.Sprintf("Generated command: '%s --debug "+
|
||||||
|
"uninstall just_a_band_huff_and_puff'\n", helmBin), stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func (suite *UninstallTestSuite) TestPrepareRequiresRelease() {
|
||||||
|
// These aren't really expected, but allowing them gives clearer test-failure messages
|
||||||
|
suite.mockCmd.EXPECT().Stdout(gomock.Any()).AnyTimes()
|
||||||
|
suite.mockCmd.EXPECT().Stderr(gomock.Any()).AnyTimes()
|
||||||
|
|
||||||
|
u := Uninstall{}
|
||||||
|
err := u.Prepare(Config{})
|
||||||
|
suite.EqualError(err, "release is required", "Uninstall.Release should be mandatory")
|
||||||
|
}
|
||||||
@@ -33,7 +33,7 @@ func (u *Upgrade) Prepare(cfg Config) error {
|
|||||||
return fmt.Errorf("release is required")
|
return fmt.Errorf("release is required")
|
||||||
}
|
}
|
||||||
|
|
||||||
args := []string{"--kubeconfig", cfg.KubeConfig}
|
args := make([]string, 0)
|
||||||
|
|
||||||
if cfg.Namespace != "" {
|
if cfg.Namespace != "" {
|
||||||
args = append(args, "--namespace", cfg.Namespace)
|
args = append(args, "--namespace", cfg.Namespace)
|
||||||
|
|||||||
@@ -41,8 +41,7 @@ func (suite *UpgradeTestSuite) TestPrepareAndExecute() {
|
|||||||
|
|
||||||
command = func(path string, args ...string) cmd {
|
command = func(path string, args ...string) cmd {
|
||||||
suite.Equal(helmBin, path)
|
suite.Equal(helmBin, path)
|
||||||
suite.Equal([]string{"--kubeconfig", "/root/.kube/config", "upgrade", "--install",
|
suite.Equal([]string{"upgrade", "--install", "jonas_brothers_only_human", "at40"}, args)
|
||||||
"jonas_brothers_only_human", "at40"}, args)
|
|
||||||
|
|
||||||
return suite.mockCmd
|
return suite.mockCmd
|
||||||
}
|
}
|
||||||
@@ -55,9 +54,7 @@ func (suite *UpgradeTestSuite) TestPrepareAndExecute() {
|
|||||||
Run().
|
Run().
|
||||||
Times(1)
|
Times(1)
|
||||||
|
|
||||||
cfg := Config{
|
cfg := Config{}
|
||||||
KubeConfig: "/root/.kube/config",
|
|
||||||
}
|
|
||||||
err := u.Prepare(cfg)
|
err := u.Prepare(cfg)
|
||||||
suite.Require().Nil(err)
|
suite.Require().Nil(err)
|
||||||
u.Execute(cfg)
|
u.Execute(cfg)
|
||||||
@@ -73,8 +70,7 @@ func (suite *UpgradeTestSuite) TestPrepareNamespaceFlag() {
|
|||||||
|
|
||||||
command = func(path string, args ...string) cmd {
|
command = func(path string, args ...string) cmd {
|
||||||
suite.Equal(helmBin, path)
|
suite.Equal(helmBin, path)
|
||||||
suite.Equal([]string{"--kubeconfig", "/root/.kube/config", "--namespace", "melt", "upgrade",
|
suite.Equal([]string{"--namespace", "melt", "upgrade", "--install", "shaed_trampoline", "at40"}, args)
|
||||||
"--install", "shaed_trampoline", "at40"}, args)
|
|
||||||
|
|
||||||
return suite.mockCmd
|
return suite.mockCmd
|
||||||
}
|
}
|
||||||
@@ -84,7 +80,6 @@ func (suite *UpgradeTestSuite) TestPrepareNamespaceFlag() {
|
|||||||
|
|
||||||
cfg := Config{
|
cfg := Config{
|
||||||
Namespace: "melt",
|
Namespace: "melt",
|
||||||
KubeConfig: "/root/.kube/config",
|
|
||||||
}
|
}
|
||||||
err := u.Prepare(cfg)
|
err := u.Prepare(cfg)
|
||||||
suite.Require().Nil(err)
|
suite.Require().Nil(err)
|
||||||
@@ -105,7 +100,6 @@ func (suite *UpgradeTestSuite) TestPrepareWithUpgradeFlags() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
cfg := Config{
|
cfg := Config{
|
||||||
KubeConfig: "/root/.kube/config",
|
|
||||||
Values: "age=35",
|
Values: "age=35",
|
||||||
StringValues: "height=5ft10in",
|
StringValues: "height=5ft10in",
|
||||||
ValuesFiles: []string{"/usr/local/stats", "/usr/local/grades"},
|
ValuesFiles: []string{"/usr/local/stats", "/usr/local/grades"},
|
||||||
@@ -113,7 +107,7 @@ func (suite *UpgradeTestSuite) TestPrepareWithUpgradeFlags() {
|
|||||||
|
|
||||||
command = func(path string, args ...string) cmd {
|
command = func(path string, args ...string) cmd {
|
||||||
suite.Equal(helmBin, path)
|
suite.Equal(helmBin, path)
|
||||||
suite.Equal([]string{"--kubeconfig", "/root/.kube/config", "upgrade", "--install",
|
suite.Equal([]string{"upgrade", "--install",
|
||||||
"--version", "radio_edit",
|
"--version", "radio_edit",
|
||||||
"--dry-run",
|
"--dry-run",
|
||||||
"--wait",
|
"--wait",
|
||||||
@@ -166,7 +160,6 @@ func (suite *UpgradeTestSuite) TestPrepareDebugFlag() {
|
|||||||
stderr := strings.Builder{}
|
stderr := strings.Builder{}
|
||||||
cfg := Config{
|
cfg := Config{
|
||||||
Debug: true,
|
Debug: true,
|
||||||
KubeConfig: "/root/.kube/config",
|
|
||||||
Stdout: &stdout,
|
Stdout: &stdout,
|
||||||
Stderr: &stderr,
|
Stderr: &stderr,
|
||||||
}
|
}
|
||||||
@@ -186,7 +179,7 @@ func (suite *UpgradeTestSuite) TestPrepareDebugFlag() {
|
|||||||
|
|
||||||
u.Prepare(cfg)
|
u.Prepare(cfg)
|
||||||
|
|
||||||
want := fmt.Sprintf("Generated command: '%s --kubeconfig /root/.kube/config --debug upgrade "+
|
want := fmt.Sprintf("Generated command: '%s --debug upgrade "+
|
||||||
"--install lewis_capaldi_someone_you_loved at40'\n", helmBin)
|
"--install lewis_capaldi_someone_you_loved at40'\n", helmBin)
|
||||||
suite.Equal(want, stderr.String())
|
suite.Equal(want, stderr.String())
|
||||||
suite.Equal("", stdout.String())
|
suite.Equal("", stdout.String())
|
||||||
|
|||||||
Reference in New Issue
Block a user