MRG: Merge pull request #1 from octue/upgrade-octue-version

Set up Octue Turbsim service

.github/workflows/cd.yml

@@ -0,0 +1,22 @@
+name: cd
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    if: "!contains(github.event.head_commit.message, 'skipci')"
+    uses: octue/.github/.github/workflows/reusable-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'

.github/workflows/python-ci.yml

@@ -12,15 +12,8 @@ jobs:
     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/[email protected]
+        with:
+          path: setup.py
+          breaking_change_indicated_by: minor

.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 }}

.pre-commit-config.yaml

@@ -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]

app.py

@@ -4,7 +4,7 @@
 import tempfile
 
 from octue.resources import Datafile, Dataset
-from octue.utils.threads import run_logged_subprocess
+from octue.utils.processes import run_logged_subprocess
 
 
 logger = logging.getLogger(__name__)

app_configuration.json

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

octue.yaml

@@ -1,12 +1,5 @@
 services:
-  - name: turbsim-service
-    organisation: aerosense
+  - namespace: octue
+    name: turbsim-service
     app_configuration_path: app_configuration.json
-    project_name: aerosense-twined
-    region: europe-west1
-    repository_owner: aerosense-ai
-    repository_name: turbsim-service
-    branch_pattern: ^main$
-    dockerfile_path: Dockerfile
-    maximum_instances: 10
-    memory: 1024Mi
+    crash_diagnostics_cloud_path: gs://octue-turbsim-service/diagnostics

setup.py

@@ -3,11 +3,11 @@
 
 setup(
     name="turbsim-service",
-    version="0.1.1",
-    author="cortadocodes <cortado.codes@protonmail.com>",
+    version="0.2.0",
+    author="Marcus Lugg <marcus@octue.com>",
     py_modules=["app"],
     install_requires=[
         "coolname>=1.1,<2",
-        "octue==0.35.1",
+        "octue==0.50.1",
     ],
 )

tests/test_app.py

@@ -24,7 +24,7 @@ def test_app(self):
         """Test that the app takes input and produces an output manifest with a dataset containing a single `.bts` file."""
         runner = Runner(app_src=REPOSITORY_ROOT, twine=TWINE_PATH, output_location=OUTPUT_LOCATION)
 
-        input_manifest = Manifest(datasets={"turbsim": "gs://openfast-data/testing/turbsim"})
+        input_manifest = Manifest(datasets={"turbsim": f"gs://{os.environ['TEST_BUCKET_NAME']}/turbsim"})
 
         # Mock running an OpenFAST analysis by creating an empty output file.
         with patch("app.run_logged_subprocess", self._create_mock_output_file):

tests/test_deployment.py

@@ -20,10 +20,10 @@ def test_cloud_run_deployment(self):
         """Test that the Google Cloud Run integration works, providing a service that can be asked questions and send
         responses. An input dataset from Google Cloud Storage is used for this test.
         """
-        input_manifest = Manifest(datasets={"turbsim": "gs://openfast-data/testing/turbsim"})
+        input_manifest = Manifest(datasets={"turbsim": f"gs://{os.environ['TEST_BUCKET_NAME']}/turbsim"})
 
         child = Child(
-            id="aerosense/turbsim-service",
+            id="octue/turbsim-service:0.2.0",
             backend={"name": "GCPPubSubBackend", "project_name": os.environ["TEST_PROJECT_NAME"]},
         )