Accept profile files

.github/workflows/cd.yml

@@ -0,0 +1,27 @@
+name: cd
+
+on:
+  pull_request:
+    branches:
+      - main
+
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    if: "!contains(github.event.head_commit.message, 'skipci')"
+    uses: octue/workflows/.github/workflows/deploy-cloud-run-service.yml@main
+    permissions:
+      id-token: write
+      contents: read
+    with:
+      gcp_project_name: octue-openfast
+      gcp_project_number: 86611255144
+      gcp_region: europe-west3
+      gcp_resource_affix: octue
+      gcp_service_name: turbsim-service
+      local_dockerfile: ./Dockerfile
+      cloud_run_flags: '--ingress=all --allow-unauthenticated --service-account=turbsim-service@octue-openfast.iam.gserviceaccount.com --max-instances=10 --memory=2048Mi'
+      env_vars: 'OCTUE_SERVICE_CONFIGURATION_PATH=/workspace/octue.yaml'

.github/workflows/codeql.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: ["main"]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["python"]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+
+          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+      # - run: |
+      #   echo "Run, Build Application using script"
+      #   ./location_of_script_within_repo/buildscript.sh
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{matrix.language}}"

.github/workflows/python-ci.yml

@@ -8,19 +8,7 @@ on:
 jobs:
   check-semantic-version:
     if: "!contains(github.event.head_commit.message, 'skipci')"
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          # Set fetch-depth to 0 to fetch all tags (necessary for git-mkver to determine the correct semantic version).
-          fetch-depth: 0
-      - uses: actions/setup-python@v2
-      - name: Install git-mkver
-        run: |
-          curl -L https://github.com/idc101/git-mkver/releases/download/v1.2.1/git-mkver-linux-amd64-1.2.1.tar.gz \
-          | tar xvz \
-          && sudo mv git-mkver /usr/local/bin
-      - name: Install semantic version checker
-        run: pip install git+https://github.com/octue/conventional-commits
-      - name: Check version
-        run: check-semantic-version setup.py
+    uses: octue/workflows/.github/workflows/check-semantic-version.yml@main
+    with:
+      path: pyproject.toml
+      breaking_change_indicated_by: minor

.github/workflows/release.yml

@@ -11,12 +11,19 @@ on:
 
 jobs:
   release:
+    if: "github.event.pull_request.merged == true"
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
 
+    - name: Install Poetry
+      uses: snok/[email protected]
+
+    - name: Check pyproject.toml file
+      run: poetry check
+
     - name: Get package version
-      run: echo "PACKAGE_VERSION=$(python setup.py --version)" >> $GITHUB_ENV
+      run: echo "PACKAGE_VERSION=$(poetry version -s)" >> $GITHUB_ENV
 
     - name: Create Release
       uses: actions/create-release@v1

.github/workflows/update-pull-request.yml

@@ -1,35 +1,26 @@
 # This workflow updates the pull request description with an auto-generated section containing the categorised commit
-# message headers of the commits since the last pull request merged into main. The auto generated section is enveloped
-# between two comments: "<!--- START AUTOGENERATED NOTES --->" and "<!--- END AUTOGENERATED NOTES --->". Anything
-# outside these in the description is left untouched. Auto-generated updates can be skipped for a commit if
+# message headers of the pull request's commits. The auto generated section is enveloped between two comments:
+# "<!--- START AUTOGENERATED NOTES --->" and "<!--- END AUTOGENERATED NOTES --->". Anything outside these in the
+# description is left untouched. Auto-generated updates can be skipped for a commit if
 # "<!--- SKIP AUTOGENERATED NOTES --->" is added to the pull request description.
 
 name: update-pull-request
 
-# Only trigger for pull requests into main branch.
-on:
-  pull_request:
-    branches:
-      - main
+on: pull_request
 
 jobs:
   description:
     if: "!contains(github.event.pull_request.body, '<!--- SKIP AUTOGENERATED NOTES --->')"
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-      with:
-        # Set fetch-depth to 0 to fetch all commit history (necessary for compiling pull request description).
-        fetch-depth: 0
-    - name: Install release note compiler
-      run: pip install git+https://github.com/octue/conventional-commits
-    - name: Compile new pull request description
-      run: |
-        echo 'PULL_REQUEST_NOTES<<EOF' >> $GITHUB_ENV
-        echo "$(compile-release-notes PULL_REQUEST_START --pull-request-url=${{ github.event.pull_request.url }} --api-token=${{ secrets.GITHUB_TOKEN }})" >> $GITHUB_ENV
-        echo EOF >> $GITHUB_ENV
-    - name: Update pull request body
-      uses: riskledger/update-pr-description@v2
-      with:
-        body: ${{ env.PULL_REQUEST_NOTES }}
-        token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: octue/[email protected]
+        id: pr-description
+        with:
+          pull_request_url: ${{ github.event.pull_request.url }}
+          api_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Update pull request body
+        uses: riskledger/update-pr-description@v2
+        with:
+          body: ${{ steps.pr-description.outputs.pull_request_description }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -129,3 +129,4 @@ dmypy.json
 .pyre/
 
 .idea
+.DS_store

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
       - id: black
         args: ['--line-length', '120']
 
-  - repo: https://gitlab.com/pycqa/flake8
+  - repo: https://github.com/PyCQA/flake8
     rev: 3.9.2
     hooks:
       - id: flake8
@@ -35,19 +35,10 @@ repos:
       - id: check-branch-name
         args:
           - '^main$'
-          - '^development$'
-          - '^devops/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^doc/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^feature/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^enhancement/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^fix/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^hotfix/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^review/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^refactor/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
-          - '^test/([a-z][a-z0-9]*)(-[a-z0-9]+)*$'
+          - "^([a-z][a-z0-9]*)(-[a-z0-9]+)*$"
 
   - repo: https://github.com/octue/conventional-commits
-    rev: 0.5.3
+    rev: 0.9.0
     hooks:
       - id: check-commit-message-is-conventional
         stages: [commit-msg]

ATTRIBUTION.md

@@ -0,0 +1,26 @@
+# ATTRIBUTION
+
+In addition to some modules of our own, `octue/turbsim-service` is based on a collection of other projects that we've
+drawn together, patched, enhanced and documented.
+
+The nature of OSS is to stand on the shoulders of giants, and we owe them a ton... here are their licenses:
+
+## `aerosense-ai/turbsim-service`
+
+<details>
+  <summary>Show license</summary>
+
+
+# turbsim-service
+
+Copyright (c) 2020-2022 The Aerosense Research Partners
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by the The Aerosense Research Partners.
+Neither the name of the The Aerosense Research Partners nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY The Aerosense Research Partners AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL The Aerosense Research Partners BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+</details>

Dockerfile

@@ -1,15 +1,34 @@
-FROM octue/openfast:3.1.0
+FROM ghcr.io/openfast/openfast:3.5.3
 
 # Allow statements and log messages to immediately appear in the Knative logs on Google Cloud.
 ENV PYTHONUNBUFFERED True
 
-ENV PROJECT_ROOT=/app
+ENV PROJECT_ROOT=/workspace
 WORKDIR $PROJECT_ROOT
 
-COPY setup.py setup.py
+RUN apt-get update -y && apt-get install -y --fix-missing curl python3.11 && rm -rf /var/lib/apt/lists/*
+
+# Install poetry.
+ENV POETRY_HOME=/root/.poetry
+ENV PATH "$POETRY_HOME/bin:$PATH"
+RUN curl -sSL https://install.python-poetry.org | python3.11 - && poetry config virtualenvs.create false;
+
+# Copy in the dependencies files for caching.
+COPY pyproject.toml poetry.lock ./
+
+# Install the dependencies only to utilise layer caching for quick rebuilds.
+RUN poetry install  \
+    --no-ansi  \
+    --no-interaction  \
+    --no-cache  \
+    --no-root  \
+    --only main
+
+# Copy local code to the application root directory.
 COPY . .
 
-RUN pip3 install -e .
+# Install local packages.
+RUN poetry install --only main
 
 EXPOSE $PORT
 

LICENSE

@@ -1,11 +1,21 @@
-# turbsim-service
+MIT License
 
-Copyright (c) 2020-2022 The Aerosense Research Partners
+Copyright (c) 2024 Octue
 
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by the The Aerosense Research Partners.
-Neither the name of the The Aerosense Research Partners nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-THIS SOFTWARE IS PROVIDED BY The Aerosense Research Partners AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL The Aerosense Research Partners BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1 @@
+# Octue Turbsim Service

app_configuration.json

@@ -1,3 +1,3 @@
 {
-    "output_location": "gs://openfast-data/output"
+    "output_location": "gs://octue-openfast-data/turbsim/output"
 }