Initial commit

.dockerignore

@@ -0,0 +1,3 @@
+pipeline.yml
+tag
+upload_pipeline.sh

Dockerfile

@@ -0,0 +1,22 @@
+FROM alpine:3.11
+MAINTAINER Drew Short <warrick@sothr.com>
+
+ARG rclone_version=v1.50.2
+ARG rclone_arch=amd64
+
+RUN apk update \
+    && apk upgrade \
+    && apk add --update bash curl unzip jq
+
+RUN cd /tmp \
+    && curl -O https://downloads.rclone.org/${rclone_version}/rclone-${rclone_version}-linux-${rclone_arch}.zip \
+    && unzip rclone-${rclone_version}-linux-${rclone_arch}.zip \
+    && cd rclone-${rclone_version}-linux-${rclone_arch} \
+    && cp rclone /usr/bin/ \
+    && chown root:root /usr/bin/rclone \
+    && chmod 755 /usr/bin/rclone \
+    && cd .. \
+    && rm -f rclone-${rclone_version}-linux-${rclone_arch}.zip \
+    && rm -rf rclone-${rclone_version}-linux-${rclone_arch}
+
+COPY ./assets/* /opt/resource/

LICENSE

@@ -0,0 +1,201 @@
+                                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.

README.md

@@ -0,0 +1,94 @@
+# concourse-rclone-compose-resource
+
+A Concourse CI resource that executes [`rclone`](https://rclone.org/) 
+against a remote host.
+
+See [Docker Hub](https://cloud.docker.com/repository/docker/warricksothr/concourse-rclone-resource)
+for tagged image versions available.
+
+## Resource Type Configuration
+
+```bash
+resource_types:
+- name: rclone
+  type: docker-image
+  source:
+    repository: warricksothr/concourse-rclone-resource
+    tag: latest
+```
+
+## Source Configuration
+
+* `config`: Required. The rclone config file contents to use.
+* `files`: Optional. Additional files to write to the /tmp directory. This is a map of key/value pairs for the filename and contents of that file
+
+### Example
+
+```bash
+resources:
+- name: docker-compose
+  type: docker-compose
+  source:
+    config: |
+      [remote]
+        client_id = <Your ID>
+        client_secret = <Your Secret>
+        scope = drive
+        root_folder_id = <Your root folder id>
+        service_account_file = /tmp/serviceAccountFile
+        token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2014-03-16T13:57:58.955387075Z"}
+    files:
+      serviceAccountFile: |
+        ...contents...
+```
+
+### Note
+
+It's highly recommended to use secrets mangement to avoid storing sensitive credentials in the pipeline
+
+## Behaviour
+
+### `check`: No-Op
+
+### `in`: No-Op
+
+### `out`: Execute `rclone`
+
+#### Parameters
+
+* `source`: Required. The path to the source files.
+* `destination`: Required. The rclone destination for the files. ex. `remote:some/location`
+* `subdir`: Optional. A file that includes additional path information to be appended to the end of destination.
+
+#### Example
+
+```bash
+# Extends example in Source Configuration
+
+jobs:
+- name:
+  plan:
+  - do:
+    - get: code # git resource
+    - put: rclone
+      params:
+        source: code
+        destination: "remote:backup"
+        subdir: code/target
+```
+
+## License
+
+Copyright 2020 Drew Short
+
+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.

assets/check

@@ -0,0 +1,2 @@
+#!/bin/sh
+printf []

assets/common.sh

@@ -0,0 +1,25 @@
+export TMPDIR=${TMPDIR:-/tmp}
+
+load_config() {
+    local config_path=$TMPDIR/rclone_config
+
+    (jq -r '.source.config // empty' < $1) > $config_path
+
+    if [ -s $config_path ]; then
+        mkdir -p /opt/rclone/config
+        mv $config_path > /opt/rclone/config/.rclone.conf
+        chmod 500 /opt/rclone/config/.rclone.conf
+    else
+        echo "No config provided"
+        exit 1
+    fi
+}
+
+load_files() {
+    local files=$(jq -r '.source.files | keys | join(" ")' < $1)
+    for fileName in files; do
+        local jq_path=".source.files.${fileName}"
+        local content=$(jq -r "${jq_path}" < $1)
+        echo "$content" > "/tmp/${fileName}"
+    done
+}

assets/in

@@ -0,0 +1,2 @@
+#!/bin/sh
+printf []

assets/out

@@ -0,0 +1,43 @@
+#!/bin/bash
+
+set -e
+
+exec 3>&1 # make stdout available as fd 3 for the result
+exec 1>&2 # redirect all output to stderr for logging
+
+source $(dirname $0)/common.sh
+
+source=$1
+
+if [ -z "$source" ]; then
+  echo "usage: $0 <path/to/source>"
+  exit 1
+fi
+
+# for jq
+PATH=/usr/local/bin:$PATH
+
+payload=$(mktemp $TMPDIR/rclone-resource-request.XXXXXX)
+cat > $payload <&0
+
+load_config $payload
+load_files $payload
+
+rclone_source_directory=$(jq -r '.params.source // ""' < $payload)
+rclone_destination=$(jq -r '.params.destination // ""' < $payload)
+rclone_destination_subdir=$(jq -r '.params.subdir // ""' < $payload)
+
+if [ -z "$rclone_source_directory" ]; then
+  echo "invalid source directory (missing source)"
+  exit 1
+fi
+
+if [ -z "$rclone_destination" ]; then
+  echo "invalid destination (missing destination)"
+  exit 1
+fi
+
+rclone_source="local:${source}/${rclone_source_directory}"
+rclone_target="${rclone_destination}${rclone_destination_subdir}"
+
+rclone copy "${rclone_source}" "${rclone_target}"

pipeline.yml

@@ -0,0 +1,32 @@
+---
+resources:
+  - name: git-resource
+    type: git
+    icon: git
+    source:
+      uri: ssh://git@git.nulloctet.com:8437/docker/concourse-rclone-resource.git
+      private_key: |
+        ((pull_key))
+      ignore_paths:
+        - pipeline.yml
+        - upload_pipeline.sh
+        - README.md
+  - name: git-resource-image
+    type: docker-image
+    icon: docker
+    source:
+      repository: ((nexus_docker_write.host))/concourse/rclone-resource
+      username: ((nexus_docker_write.username))
+      password: ((nexus_docker_write.password))
+
+jobs:
+  - name: build-image
+    plan:
+    - get: git-resource
+      trigger: true
+    - put: git-resource-image
+      params: 
+        build: git-resource
+        tag_file: git-resource/tag
+        tag_as_latest: true
+      get_params: {skip_download: true}

tag

@@ -0,0 +1 @@
+1.0.0

upload_pipeline.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+TEAM=docker
+PIPELINE=concourse-rclone-resource
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+pushd "${DIR}"
+
+fly -t ${TEAM} set-pipeline --pipeline ${PIPELINE} --config pipeline.yml
+
+popd