commit 527821d3d9f8b2db57ad5eb7ded1beb73e7308e6 Author: Brad Rydzewski Date: Fri Oct 16 13:09:45 2015 -0700 initial commit diff --git a/.drone.sec b/.drone.sec new file mode 100644 index 0000000..7f5aa2c --- /dev/null +++ b/.drone.sec @@ -0,0 +1 @@ +eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhHQ00ifQ.waldmmzYiLrJb-IGTrZrgpQynH7j3Gg9l3Go2yOlpdalSDBQPnPHVUX13rQDE6d-jOtkU9d5jDDm-jqUFJxpC_iUOydpul-c_IK1x3Llhvtff2ACHLmhQATOaFcF9M3LPVM-8_UesIUltdKbaNgkg94knXx_KWnP_-GC0iroKljcUx67cJDrvfCKwYAwumH_c1aelFB5pxXKTsyWT-cq99-M34bDgAm0Opw0u8G60q6xjDYdUgQfzllrXzWouA8A-y2-m6JUeEv22u-yavdmA-KurtJhtrcnrb0JIhHbXHQ6RECOf_Pb2LCKNIP173gSmH0xaw3wcQ0jKbWNzodwRQ.yIdC4WIXCthzXa25.IG2Bvn9CtZCLE7KojfHKkkHUXhqbvcJxARQa-MYXHitbezlkpkwvEb3ITiiuZ9dR0KoWCN7fS8Q9jh7qJHQhAlKCCZJrlc7vyrON3-ZCgqT_PQ5f-1VXwN7f8Xsh05NUrq1s2StwGDz706IbsW0d13Trb8W9SeQ8XcCaeb6-KqKPYCh3RHg5of4AXa306lHIt1B1jRYlMkki22s9Ra08PnXMG5P7cVJhOiUmQQ.DektznGNfHQZEM-5g3BIFA diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000..1248801 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,32 @@ +build: + image: golang:1.5 + environment: + - GO15VENDOREXPERIMENT=1 + - GOOS=linux + - GOARCH=amd64 + - CGO_ENABLED=0 + commands: + - go get + - go build + - go test + +publish: + docker: + username: drone + password: $$DOCKER_PASS + email: $$DOCKER_EMAIL + repo: plugins/drone-s3-sync + when: + branch: master + +plugin: + name: S3 Sync + desc: Syncs a directory with an Amason S3 Bucket + type: publish + image: plugins/drone-s3-sync + labels: + - publish + - artifacts + - amazon + - aws + - s3 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ddde65e --- /dev/null +++ b/.gitignore @@ -0,0 +1,26 @@ +# Compiled Object files, Static and Dynamic libs (Shared Objects) +*.o +*.a +*.so + +# Folders +_obj +_test + +# Architecture specific extensions/prefixes +*.[568vq] +[568vq].out + +*.cgo1.go +*.cgo2.c +_cgo_defun.c +_cgo_gotypes.go +_cgo_export.* + +_testmain.go + +*.exe +*.test +*.prof + +drone-s3-sync \ No newline at end of file diff --git a/DOCS.md b/DOCS.md new file mode 100644 index 0000000..7db18d8 --- /dev/null +++ b/DOCS.md @@ -0,0 +1,28 @@ +Use the S3 sync plugin to synchronize files and folders with an Amazon S3 bucket. The following parameters are used to configure this plugin: + +* `access_key` - amazon key +* `secret_key` - amazon secret key +* `bucket` - bucket name +* `region` - bucket region (`us-east-1`, `eu-west-1`, etc) +* `acl` - access to files that are uploaded (`private`, `public-read`, etc) +* `source` - location of folder to sync +* `target` - target folder in your S3 bucket +* `delete` - deletes files in the target not found in the source +* `include` - don't exclude files that match the specified pattern +* `exclude` - exclude files that match the specified pattern +* `content-type` - override default mime-tpyes to use this value + +The following is a sample S3 configuration in your .drone.yml file: + +```yaml +publish: + s3_sync: + acl: public-read + region: "us-east-1" + bucket: "my-bucket.s3-website-us-east-1.amazonaws.com" + access_key: "970d28f4dd477bc184fbd10b376de753" + secret_key: "9c5785d3ece6a9cdefa42eb99b58986f9095ff1c" + source: folder/to/archive + target: /target/location + delete: true +``` \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..89a1639 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,12 @@ +# Docker image for the Drone build runner +# +# CGO_ENABLED=0 go build -a -tags netgo +# docker build --rm=true -t plugins/drone-s3-sync . + +FROM gliderlabs/alpine:3.1 +RUN apk add --update \ + python \ + py-pip \ + && pip install awscli +ADD drone-s3 /bin/ +ENTRYPOINT ["/bin/drone-s3-sync"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8f71f43 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/logo.svg b/logo.svg new file mode 100644 index 0000000..70a7843 --- /dev/null +++ b/logo.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/main.go b/main.go new file mode 100644 index 0000000..1429e19 --- /dev/null +++ b/main.go @@ -0,0 +1,161 @@ +package main + +import ( + "fmt" + "os" + "os/exec" + "strings" + + "github.com/drone/drone-plugin-go/plugin" +) + +type S3 struct { + Key string `json:"access_key"` + Secret string `json:"secret_key"` + Bucket string `json:"bucket"` + + // us-east-1 + // us-west-1 + // us-west-2 + // eu-west-1 + // ap-southeast-1 + // ap-southeast-2 + // ap-northeast-1 + // sa-east-1 + Region string `json:"region"` + + // Indicates the files ACL, which should be one + // of the following: + // private + // public-read + // public-read-write + // authenticated-read + // bucket-owner-read + // bucket-owner-full-control + Access string `json:"acl"` + + // Copies the files from the specified directory. + // Regexp matching will apply to match multiple + // files + // + // Examples: + // /path/to/file + // /path/to/*.txt + // /path/to/*/*.txt + // /path/to/** + Source string `json:"source"` + Target string `json:"target"` + + // Include or exclude all files or objects from the command + // that matches the specified pattern. + Include string `json:"include"` + Exclude string `json:"exclude"` + + // Files that exist in the destination but not in the source + // are deleted during sync. + Delete bool `json:"delete"` + + // Specify an explicit content type for this operation. This + // value overrides any guessed mime types. + ContentType string `json:"content_type"` +} + +func main() { + workspace := plugin.Workspace{} + vargs := S3{} + + plugin.Param("workspace", &workspace) + plugin.Param("vargs", &vargs) + plugin.MustParse() + + // skip if AWS key or SECRET are empty. A good example for this would + // be forks building a project. S3 might be configured in the source + // repo, but not in the fork + if len(vargs.Key) == 0 || len(vargs.Secret) == 0 { + return + } + + // make sure a default region is set + if len(vargs.Region) == 0 { + vargs.Region = "us-east-1" + } + + // make sure a default access is set + // let's be conservative and assume private + if len(vargs.Access) == 0 { + vargs.Access = "private" + } + + // make sure a default source is set + if len(vargs.Source) == 0 { + vargs.Source = "." + } + + // if the target starts with a "/" we need + // to remove it, otherwise we might adding + // a 3rd slash to s3:// + if strings.HasPrefix(vargs.Target, "/") { + vargs.Target = vargs.Target[1:] + } + vargs.Target = fmt.Sprintf("s3://%s/%s", vargs.Bucket, vargs.Target) + + cmd := command(vargs) + cmd.Env = os.Environ() + cmd.Env = append(cmd.Env, "AWS_ACCESS_KEY_ID="+vargs.Key) + cmd.Env = append(cmd.Env, "AWS_SECRET_ACCESS_KEY="+vargs.Secret) + cmd.Dir = workspace.Path + cmd.Stdout = os.Stdout + cmd.Stderr = os.Stderr + trace(cmd) + + // run the command and exit if failed. + err := cmd.Run() + if err != nil { + os.Exit(1) + } +} + +// command is a helper function that returns the command +// and arguments to upload to aws from the command line. +func command(s S3) *exec.Cmd { + + // command line args + args := []string{ + "s3", + "sync", + s.Source, + s.Target, + "--acl", + s.Access, + "--region", + s.Region, + } + + // append delete flag if specified + if s.Delete { + args = append(args, "--delete") + } + // append include flag if specified + if len(s.Include) != 0 { + args = append(args, "--include") + args = append(args, s.Include) + } + // appends exclude flag if specified + if len(s.Exclude) != 0 { + args = append(args, "--exclude") + args = append(args, s.Exclude) + } + // appends content-type if specified + if len(s.ContentType) != 0 { + args = append(args, "--content-type") + args = append(args, s.ContentType) + } + + return exec.Command("aws", args...) +} + +// trace writes each command to standard error (preceded by a ‘$ ’) before it +// is executed. Used for debugging your build. +func trace(cmd *exec.Cmd) { + fmt.Println("$", strings.Join(cmd.Args, " ")) +}