Skip to content

Commit c2271ca

Browse files
author
Scott Walker
committed
Initial commit
1 parent 30489c0 commit c2271ca

37 files changed

+4541
-2
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build

‎CODE-OF-CONDUCT.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Code of Conduct for Lyra
2+
3+
While we have specific guidelines for various tools (see links below), in general, you should:
4+
5+
- **Be nice**: Be courteous, respectful and polite to fellow community members. No offensive comments related to gender, gender identity or expression, sexual orientation, disability, physical appearance, body size, race, religion; no sexual images in public spaces, real or implied violence, intimidation, oppression, stalking, following, harassing photography or recording, sustained disruption of talks or other events, inappropriate physical contact, or unwelcome sexual attention will be tolerated.
6+
- **Encourage diversity and participation**: Make everyone in our community feel welcome, regardless of their background, and do everything possible to encourage participation in our community.
7+
- **Keep it legal**: Basically, don't get us in trouble. Share only content that you own, do not share private or sensitive information, and don't break the law.
8+
- **Stay on topic**: Make sure that you are posting to the correct online channel and avoid off-topic discussions. Also remember that nobody likes spam.
9+
10+
Guideline violations --- 3 strikes method
11+
-----
12+
13+
The point of this section is not to find opportunities to punish people, but we do need a fair way to deal with people who do harm to our community. Extreme violations of a threatening, abusive, destructive, or illegal nature will be addressed immediately and are not subject to 3 strikes.
14+
15+
1. **First occurrence**: We'll give you a friendly, but public, reminder that the behavior is inappropriate according to our guidelines.
16+
2. **Second occurrence**: We'll send you a private message with a warning that any additional violations will result in removal from the community.
17+
3. **Third occurrence**: Depending on the violation, we might need to delete or ban your account.
18+
19+
Notes:
20+
21+
- Obvious spammers are banned on first occurrence. If we don’t do this, we’ll have spam all over the place.
22+
- People who are committing minor formatting / style infractions will get some education, rather than hammering them in the 3 strikes process.
23+
- Contact [email protected] to report abuse or appeal violations.
24+
25+
Activity-specific guidelines
26+
-----
27+
28+
- [Getting technical help](#getting-technical-help)
29+
- [Issue guidelines](#bug-guidelines)
30+
- [Git / source guidelines](#git--source-guidelines)
31+
32+
### Getting technical help
33+
34+
Filing an issue in the GitHub repo is the best way to seek out technical help.
35+
36+
### Issue guidelines
37+
38+
You can log issue and bug reports for Lyra by filing issues against [the repository](https://github.com/lyraproj/lyra/issues).
39+
40+
Here are a few guidelines that apply specifically to filing issues:
41+
42+
- Each report is for only one issue. If you find several issues, please separate them into several reports.
43+
- Search before you file an issue, and try to avoid filing duplicates by taking a look at whether your issue has already been filed before.
44+
- Don't start debates on topics not directly related to the scope of a specific issue. Create another issue.
45+
- Remove unnecessary lines when quoting other comments.
46+
- Please double check to make sure that the information you are including is public (not confidential), especially in attached log files or screenshots.
47+
48+
### Git / source guidelines
49+
50+
- If you want to contribute code, start with a discussion on a pull request or issue to make sure that what you want to submit is a good idea and architected in a way that will be useful for others.
51+
- Look at existing pull requests and issues to make sure that you aren’t duplicating effort.
52+
- Review any existing CONTRIBUTOR.MD files associated with the project.
53+
- If you are new to git or GitHub, you might find these resources useful: [GitHub help files](http://help.github.com/), [Git cheat sheets](http://help.github.com/git-cheat-sheets/), and [Git Reference documentation](http://gitref.org/).
54+
55+
### Credits
56+
57+
Credit to [01.org](https://01.org/community/participation-guidelines) and [meego.com](http://wiki.meego.com/Community_guidelines), since they formed the starting point for many of these guidelines.
58+
59+
### License
60+
61+
These documents belong to the community and are licensed under the Creative Commons. You can help improve them!
62+
63+
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/3.0/us/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/us/">Creative Commons Attribution-Share Alike 3.0 United States License</a>.

‎CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing to Lyra
2+
3+
## Code of Conduct
4+
Review our [Code of Conduct](https://github.com/lyraproj/lyra/blob/master/CODE-OF-CONDUCT.md).
5+
6+
## How to ask a question
7+
Browse for existing issues. Otherwise, open a "[new issue](https://github.com/lyraproj/lyra/issues/new)" in this repo.
8+
9+
## How to report a bug
10+
11+
Open a "[Bug report](https://github.com/lyraproj/lyra/issues/new?template=bug_report.md)" issue in this repo.
12+
13+
## How to suggest a new feature
14+
15+
Open a "[Feature request](https://github.com/lyraproj/lyra/issues/new?template=feature_request.md)" issue in this repo.
16+
17+
## Development Environment
18+
19+
### Requirements
20+
21+
* Golang 1.11
22+
23+
### Building & running
24+
25+
You can build a native binary and default plugins by simply invoking `make`.
26+
```
27+
make
28+
```
29+
30+
The resulting binaries will be placed in the `build` directory.
31+
32+
## Submitting Changes
33+
Fork the repo, make changes, file a Pull Request.

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎Makefile

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
OS_TYPE=$(shell echo `uname`| tr '[A-Z]' '[a-z]')
2+
ifeq ($(OS_TYPE),darwin)
3+
OS := osx
4+
else
5+
OS := linux
6+
endif
7+
8+
HAS_REQUIRED_GO := $(shell go version | grep -E 'go[2-9]|go1.1[2-9]|go1.11.[4-9]')
9+
10+
LDFLAGS += -X "$(PACKAGE_NAME)/pkg/version.BuildTime=$(shell date -u '+%Y-%m-%d %I:%M:%S %Z')"
11+
LDFLAGS += -X "$(PACKAGE_NAME)/pkg/version.BuildTag=$(shell git describe --all --exact-match `git rev-parse HEAD` | grep tags | sed 's/tags\///')"
12+
LDFLAGS += -X "$(PACKAGE_NAME)/pkg/version.BuildSHA=$(shell git rev-parse --short HEAD)"
13+
14+
GO_PLUGINS := $(subst cmd/,,$(wildcard cmd/goplugin-*))
15+
16+
PHONY+= default
17+
default: LINTFLAGS = --fast
18+
default: everything
19+
20+
PHONY+= all
21+
all: LDFLAGS += -s -w # Strip debug information
22+
all: TESTFLAGS = --race
23+
all: everything
24+
25+
PHONY+= everything
26+
everything: check-mods clean lint test plugins sanity
27+
28+
PHONY+= plugins
29+
plugins: check-mods
30+
@$(foreach plugin,$(GO_PLUGINS),$(call build,goplugins/$(subst goplugin-,,$(plugin)),cmd/$(plugin)/main.go);)
31+
32+
PHONY+= harness
33+
harness: check-mods
34+
@$(call build,test-harness,cmd/test-harness/main.go)
35+
36+
PHONY+= test
37+
test:
38+
@echo "🔘 Testing ... (`date '+%H:%M:%S'`)"
39+
@go test github.com/lyraproj/aws-example/...
40+
41+
PHONY+= clean
42+
clean:
43+
@echo "🔘 Cleaning ..."
44+
@rm -rf build
45+
46+
PHONY+= lint
47+
lint: $(GOPATH)/bin/golangci-lint
48+
@$(foreach plugin,$(GO_PLUGINS),$(call checklint,cmd/$(plugin)/...);)
49+
50+
PHONY+= sanity
51+
sanity: harness
52+
@$(foreach plugin,$(GO_PLUGINS),$(call checksanity,$(subst goplugin-,,$(plugin)));)
53+
54+
PHONY+= check-mods
55+
check-mods:
56+
@echo "🔘 Ensuring go version is 1.11.4 or later (`date '+%H:%M:%S'`)"
57+
@if [ "$(HAS_REQUIRED_GO)" = "" ]; \
58+
then \
59+
echo "🔴 must be running Go version 1.11.4 or later. Please upgrade and run go clean -modcache"; \
60+
exit 1; \
61+
fi
62+
@echo "✅ Go version is sufficient (`date '+%H:%M:%S'`)"
63+
@echo "🔘 Ensuring go mod is available and turned on (`date '+%H:%M:%S'`)"
64+
@GO111MODULE=on go mod download || (echo "🔴 The command 'GO111MODULE=on go mod download' did not return zero exit code (exit code was $$?)"; exit 1)
65+
@echo "✅ Go mod is available (`date '+%H:%M:%S'`)"
66+
67+
define build
68+
echo "🔘 Building - $(1) (`date '+%H:%M:%S'`)"
69+
mkdir -p build/
70+
GO111MODULE=on go build -ldflags '$(LDFLAGS)' -o build/$(1) $(2)
71+
echo "✅ Build complete - $(1) (`date '+%H:%M:%S'`)"
72+
endef
73+
74+
define checklint
75+
echo "🔘 Linting $(1) (`date '+%H:%M:%S'`)"
76+
lint=`GO111MODULE=on golangci-lint run $(LINTFLAGS) $(1)`; \
77+
if [ "$$lint" != "" ]; \
78+
then echo "🔴 Lint found"; echo "$$lint"; exit 1;\
79+
else echo "✅ Lint-free (`date '+%H:%M:%S'`)"; \
80+
fi
81+
endef
82+
83+
define checksanity
84+
echo "🔘 Sanity checking $(1) (`date '+%H:%M:%S'`)"
85+
sanity=`GO111MODULE=on build/test-harness build/goplugins/$(1)`; \
86+
if [ "$$?" != 0 ]; \
87+
then echo "🔴 Sanity check failed"; echo "$$sanity"; exit 1;\
88+
else echo "✅ Sanity check complete (`date '+%H:%M:%S'`)"; \
89+
fi
90+
endef
91+
92+
$(GOPATH)/bin/golangci-lint:
93+
@echo "🔘 Installing golangci-lint... (`date '+%H:%M:%S'`)"
94+
@GO111MODULE=off go get github.com/golangci/golangci-lint/cmd/golangci-lint
95+
96+
.PHONY: $(PHONY)

0 commit comments

Comments
 (0)