diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..21d0b898ff61470da684cc5e8f7d6efa648de8cf
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.venv/
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
new file mode 100644
index 0000000000000000000000000000000000000000..83ca3abb98bf060de3f14a7a4bba5f4b3d8f5454
--- /dev/null
+++ b/.gitlab-ci.yml
@@ -0,0 +1,37 @@
+
+
+lint:
+ image: python:latest
+ stage: .pre
+ script:
+ - python3 -m pip install pre-commit
+ - pre-commit install
+ - pre-commit run --all-files
+
+build:
+ image: docker:latest
+ stage: build
+ variables:
+ DOCKER_DRIVER: overlay
+ DOCKER_TLS_CERTDIR: ""
+ services:
+ - docker:dind
+ script:
+ - apk add --update --no-cache python3 git
+ - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
+ - ./build.py "$CI_REGISTRY_USER" "$CI_REGISTRY_PASSWORD" --build
+
+deploy:
+ image: docker:latest
+ stage: deploy
+ variables:
+ DOCKER_DRIVER: overlay
+ DOCKER_TLS_CERTDIR: ""
+ services:
+ - docker:dind
+ script:
+ - apk add --update --no-cache python3 git
+ - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
+ - ./build.py "$CI_REGISTRY_USER" "$CI_REGISTRY_PASSWORD" --build --push
+ only:
+ - main
\ No newline at end of file
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..dff2da91b66ead08da6b24535e5980b900505a66
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,30 @@
+default_stages: [commit]
+
+repos:
+
+- repo: https://github.com/timothycrosley/isort
+ rev: 5.9.3
+ hooks:
+ - id: isort
+ stages: [ commit ]
+
+- repo: https://github.com/ambv/black
+ rev: 21.7b0
+ hooks:
+ - id: black
+ stages: [commit]
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+ rev: v0.910
+ hooks:
+ - id: mypy
+
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v4.0.1
+ hooks:
+ - id: check-added-large-files
+ - id: check-merge-conflict
+ - id: check-yaml
+ - id: mixed-line-ending
+ stages: [commit]
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000000000000000000000000000000000000..d346fe2466db19244a401a568117c3a26a0fa8cb
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,27 @@
+ARG ND280_VERSION=12.31
+
+FROM git.t2k.org:8088/nd280/framework/nd280softwaremaster:${ND280_VERSION}
+
+ARG GIT_T2K_USERNAME
+ARG GIT_T2K_TOKEN
+ARG HIGHLAND_VERSION=2.67
+
+SHELL ["/bin/bash", "-c"]
+
+# Get latest software pilot, software policy, and check out Highland source code
+RUN cd ${COMMON_BUILD_PREFIX} \
+ && rm -rf nd280SoftwarePilot \
+ && rm -rf nd280SoftwarePolicy_* \
+ && export ND280_GIT=https://${GIT_T2K_USERNAME}:${GIT_T2K_TOKEN}@git.t2k.org/nd280/ \
+ && git clone ${ND280_GIT}pilot/nd280SoftwarePilot.git \
+ && (cd nd280SoftwarePilot && ./configure.sh) \
+ && source nd280SoftwarePilot/nd280SoftwarePilot.profile \
+ && git clone ${ND280_GIT}highland2Software/highland2SoftwarePilot.git \
+ && source highland2SoftwarePilot/highland2SoftwarePilot.profile \
+ && highland-install -j$(nproc) -c ${HIGHLAND_VERSION}
+
+# Build the Highland source code
+RUN cd ${COMMON_BUILD_PREFIX} \
+ && source nd280SoftwarePilot/nd280SoftwarePilot.profile \
+ && source highland2SoftwarePilot/highland2SoftwarePilot.profile \
+ && highland-install -s ${HIGHLAND_VERSION}
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..3d332846513a88288e46b761887e8fc21804f4c4
--- /dev/null
+++ b/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.
\ No newline at end of file
diff --git a/README.md b/README.md
index ad80846ec87abc72764b6b8a9eb08ad5d59bb440..7047e54372cc4047e4c40514f45586a4856ecca4 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,34 @@
# Highland Container
+## Build Instructions
+
+On a machine with Docker installed run:
+
+```
+docker login https://git.t2k.org:8088 --username=<your_username>
+./build.py --build <your_t2k_username> <your_t2k_gitlab_access_token> --highland=<highland_version> --nd280=<nd280_version>
+```
+
+You will need a T2K [GitLab personal access token](https://git.t2k.org/-/profile/personal_access_tokens).
+You may generate one of these at: <https://git.t2k.org/-/profile/personal_access_tokens>.
+
+See the [ND280 wiki](https://git.t2k.org/nd280/wiki/nd280-wiki/-/wikis/home)
+for more information on [Docker](https://git.t2k.org/nd280/wiki/nd280-wiki/-/wikis/CIDocker).
+
+## Release Instructions
+
+Build a docker highland docker container according to the instructions above.
+
+To push the built container to the [package registry](https://git.t2k.org/dhadley/highland-container/container_registry) do:
+
+```
+./build.py --push <your_t2k_username> <your_t2k_gitlab_access_token> --highland=<highland_version> --nd280=<nd280_version>
+```
+
+## Development Instructions
+
+After cloning the repository from <https://git.t2k.org/dhadley/highland-container.git>
+please `source setup.sh` before making modifications and committing any changes.
+This will setup the environment and install the `pre-commit` hooks.
+
+Please report any bugs or issues at <https://git.t2k.org/dhadley/highland-container/-/issues>.
\ No newline at end of file
diff --git a/build.py b/build.py
new file mode 100755
index 0000000000000000000000000000000000000000..f4325cf1989a541eac98eb530c481b824122e5c0
--- /dev/null
+++ b/build.py
@@ -0,0 +1,77 @@
+#!/usr/bin/env python3
+from argparse import ArgumentParser, Namespace
+from subprocess import run
+
+
+def _main() -> None:
+ args = _parsecml()
+ accesstoken = args.token
+ username = args.username
+ highland_version = args.highland
+ nd280_version = args.nd280
+ thisversion = (
+ run(
+ "git describe --tags || git rev-parse --short HEAD",
+ shell=True,
+ check=True,
+ capture_output=True,
+ )
+ .stdout.decode()
+ .rstrip()
+ )
+ tagname = "_".join((nd280_version, highland_version, thisversion))
+ tagnamelatest = "_".join((nd280_version, highland_version, "latest"))
+ runall = (not args.build) and (not args.push)
+ if args.build or runall:
+ run(
+ [
+ "docker",
+ "build",
+ "-t",
+ f"git.t2k.org:8088/dhadley/highland-container:{tagname}",
+ "-t",
+ f"git.t2k.org:8088/dhadley/highland-container:{tagnamelatest}",
+ "--build-arg",
+ f"GIT_T2K_TOKEN={accesstoken}",
+ "--build-arg",
+ f"GIT_T2K_USERNAME={username}",
+ "--build-arg",
+ f"HIGHLAND_VERSION={highland_version}",
+ "--build-arg",
+ f"ND280_VERSION={nd280_version}",
+ ".",
+ ],
+ check=True,
+ )
+ if args.push or runall:
+ for tn in [tagname, tagnamelatest]:
+ run(
+ [
+ "docker",
+ "push",
+ f"git.t2k.org:8088/dhadley/highland-container:{tn}",
+ ],
+ check=True,
+ )
+ return
+
+
+def _parsecml() -> Namespace:
+ parser = ArgumentParser()
+ parser.add_argument("username", help="T2K Gitlab username.", type=str)
+ parser.add_argument("token", help="T2K Gitlab personal access token.", type=str)
+ parser.add_argument(
+ "--highland", help="Highland version.", type=str, default="2.67"
+ )
+ parser.add_argument("--nd280", help="ND280 version.", type=str, default="12.31")
+ parser.add_argument("--build", action="store_true", help="Build")
+ parser.add_argument(
+ "--push",
+ action="store_true",
+ help="Push built image to the container registry.",
+ )
+ return parser.parse_args()
+
+
+if __name__ == "__main__":
+ _main()
diff --git a/setup.sh b/setup.sh
new file mode 100644
index 0000000000000000000000000000000000000000..793c0b79ebfdad0cbe456f35421e99b5ea2f3d6b
--- /dev/null
+++ b/setup.sh
@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+if [ ! -z "$BASH" ] && [ ! -z "$BASH_SOURCE" ];
+then
+ scriptname="${BASH_SOURCE}";
+elif [ ! -z "${ZSH_NAME}" ] && [ ! -z "${(%):-%N}" ];
+then
+ scriptname="${(%):-%N}";
+elif [ ! -z "$KSH_VERSION" ];
+then
+ scriptname="${.sh.file}"
+else
+ echo "Unsupported shell detected. Try: bash, zsh or ksh."
+ return 1;
+fi
+
+SCRIPT_PATH=$(cd -- $(dirname "${scriptname}") && pwd)
+
+if [ ! -d "${SCRIPT_PATH}/.venv" ];
+then
+ command -v python3 >/dev/null 2>&1 && PYTHONCMD=python3 || PYTHONCMD=python;
+ ${PYTHONCMD} -m venv --prompt highland-container ${SCRIPT_PATH}/.venv \
+ && . ${SCRIPT_PATH}/.venv/bin/activate \
+ && python -m pip install --upgrade pip \
+ && python -m pip install pre-commit
+fi
+. ${SCRIPT_PATH}/.venv/bin/activate
+
+export PATH=${SCRIPT_PATH}/bin:${PATH}
+
+# Install pre-commit hooks if they have not already been installed
+if test -d "${SCRIPT_PATH}/.git" && ! test -f "${SCRIPT_PATH}/.git/hooks/pre-commit";
+then
+ (cd ${SCRIPT_PATH}; pre-commit install)
+fi
\ No newline at end of file