Open Sourcing ... 🦊🎉

.github/workflows/ci.yml

@@ -91,8 +91,13 @@ jobs:
           # NOTE: we are unable to solely rely on pip because poetry doesn't export the dev dependencies
           #       as extras nor is it able to install ONLY the dev dependencies ...
           python -m poetry install
-      - run: python -m pytest
+      - run: python -m pytest --ignore=tests/e2e
         env:
+          # FoxOps test configuration
+          FOXOPS_GITLAB_ADDRESS: https://nonsense.com/api/v4
+          FOXOPS_GITLAB_TOKEN: nonsense
+
+          # Test runner configuration
           COVERAGE_FILE: .coverage.${{ matrix.python-version }}
 
       - name: Upload coverage data

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+This project uses [Poetry](https://python-poetry.org/)
+and [poetry-dynamic-versioning](https://pypi.org/project/poetry-dynamic-versioning/)
+for dependency management and the package building process.
+
+## Local Development
+
+tbd.
+
+### Documentation
+
+run `make live` in the `docs/` subfolder to start a web server that hosts a live-build of the documentation. It even auto-reloads in case of changes!

Dockerfile

@@ -1,7 +1,8 @@
+# ================= BUILD ==================
 FROM python:3.10-alpine AS builder
 
 # Install the build system
-RUN apk add --update git gcc musl-dev
+RUN apk add --update git
 RUN python -m pip install -U pip wheel
 RUN python -m pip install build
 
@@ -14,12 +15,14 @@ RUN python -m build --wheel .
 
 
 # =============== PRODUCTION ===============
-FROM builder AS production
+FROM python:3.10-alpine
 
 # Copy the build artifact
 COPY --from=builder /build/dist/*.whl /tmp
 
 # Install the application
+RUN apk add --update git gcc musl-dev
 RUN python -m pip install /tmp/*.whl
+RUN rm -f /tmp/*.whl
 
 ENTRYPOINT [ "foxops" ]

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.

README.md

@@ -1,3 +1,23 @@
-# foxops
+# foxops 🦊
 
-coming soon, stay tuned! 🦊
+A modest templating tool to keep your projects up-to-date.
+
+more coming soon, stay tuned! 🚧
+
+## Documentation
+
+The documentation is available on rtd: https://foxops.readthedocs.io
+
+## Installation
+
+The `foxops` package is available on PyPI and can be installed using `pip`:
+
+```shell
+python -m pip install foxops
+```
+
+The `foxops` is available in a container image hosted on [ghcr](https://github.com/Roche/foxops/pkgs/container/foxops):
+
+```shell
+docker run -it --rm ghcr.io/roche/foxops --help
+```

docs/source/advanced_usage.md

@@ -0,0 +1,87 @@
+# Advanced Usage
+
+## Authentication to Git Repositories
+
+tbd.
+
+## Deployment of foxops
+
+Foxops is typically deployed in a GitLab CI pipeline. The fundamental approach here is to also use the GitOps principle for the configuration of your desired template incarnations.
+
+As a general approach we would recommend to setup the Git repository like this:
+
+```text
+/v1/
+.gitlab-ci.yml
+```
+
+The `v1` folder is here to indicate that the contained incarnation definition files follow the foxops v1 schema. It will help to future-proof the repository, in case future versions of foxops will bring breaking changes.
+
+In the GitLab CI pipeline, the `foxops reconcile v1/` command can be used, to ensure that all incarnations match the desired state as defined in the files within the `v1/` directory.
+
+### Example .gitlab-ci.yaml
+
+Do note that foxops requires a GitLab API token. For the example above this token must be present in the `GITLAB_API_TOKEN` environment variable.
+
+```yaml
+variables:
+  FOXOPS_VERSION: "1"
+  FOXOPS_GITLAB_TOKEN: $GITLAB_API_TOKEN
+  FILES_TO_RECONCILE: v1/
+
+stages:
+  - run
+
+reconcile:
+  stage: run
+
+  # resource_group prevents parallel executions of foxops.
+  # This can be removed, to allow executing multiple "foxops reconcile" runs in parallel
+  # => at the risk of undefined behavior, if multiple commits affecting the same files
+  #    are created in short intervals
+  resource_group: main
+
+  image:
+    name: ghcr.io/roche/foxops:$FOXOPS_VERSION
+    entrypoint: [""]
+
+  # only run on the default branch
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+
+  # logic that collects the files that were added/modified in the commit.
+  # improves the execution speed of `foxops reconcile` by only running it on those files
+  before_script:
+    - |
+      if [[ -z ${FILES_TO_RECONCILE} ]];then
+        FILES_TO_RECONCILE=()
+
+        for file in $(git diff-tree -M --diff-filter=AM --no-commit-id --name-only -r "${CI_COMMIT_SHA}"); do
+          if [[ "${file}" =~ ^(v1|v0.7).*\.(yaml|yml)$ ]] ; then
+            FILES_TO_RECONCILE[${#FILES_TO_RECONCILE[@]}]="${file}"
+          fi
+        done
+      fi
+
+      echo "Files to reconcile: ${FILES_TO_RECONCILE[@]}"
+
+  # gitlab-runners apparently always use `-e` causing the real `foxops` exit code
+  # to be ignored and always use `1` instead. We have to manually handle it ourselves.
+  script:
+    - |
+      if [[ ${#FILES_TO_RECONCILE[@]} == 0 ]];then
+       echo "No incarnation configuration changes, skip running foxops reconcile ..."
+
+       exit 0
+      fi
+
+      foxops reconcile ${FILES_TO_RECONCILE[@]} || EXIT_CODE=$?
+
+      exit $EXIT_CODE
+
+  # foxops exists with code `2` if a reconciliation failed in a "known" way,
+  # and with `1` if it fails with an unhandled exceptions.
+  allow_failure:
+    exit_codes:
+      - 2
+```