Merge pull request #54 from datalab-mi/feature/get-version-in-api

Feature/get version in api
dnum-mi · Apr 29, 2022 · 92673b2 · 92673b2
2 parents 08e105a + 6c9462f
commit 92673b2
Show file tree

Hide file tree

Showing 10 changed files with 53 additions and 17 deletions.
diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml
@@ -8,8 +8,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+    - name: Get the version
+      id: get_version
+      run: |
+        echo ::set-output name=VERSION::$(cat Makefile | grep $'^TAG\t\+:= ' | sed 's/TAG\t\+:= //')
     - name: Build the Docker image
-      run: TAG=action docker-compose -f docker-compose-prod.yml build
+      run: TAG=${{ steps.get_version.outputs.VERSION }} docker-compose -f docker-compose-prod.yml build
     - name: Login to GHCR
       if: success()
       uses: docker/login-action@v1
@@ -19,7 +23,8 @@ jobs:
         password: ${{ secrets.GITHUB_TOKEN }}
     - name: Push on GHCR
       run: |
-        ./cd/scripts/docker-push.sh develop
+        ./cd/scripts/docker-push.sh ${{ steps.get_version.outputs.VERSION }} ${{ steps.get_version.outputs.VERSION }}
+        ./cd/scripts/docker-push.sh ${{ steps.get_version.outputs.VERSION }} develop
     - name: Delete untagged images
       uses: vlaurin/action-ghcr-prune@main
       with:
@@ -36,6 +41,7 @@ jobs:
         container: basegun/basegun-frontend
         dry-run: false
         untagged: true
+
   deploy-preprod:
     uses: ./.github/workflows/deploy.yml
     needs: build-push
@@ -52,3 +58,14 @@ jobs:
       OS_PROJECT_NAME: ${{ secrets.OS_PROJECT_NAME }}
       OS_USERNAME: ${{ secrets.OS_USERNAME }}
 
+  test:
+    runs-on: ubuntu-latest
+    needs: deploy-preprod
+    steps:
+      - name: Test ip
+        run : |
+          [[ "$(curl ${{ secrets.PREPROD_SERVER_IP }}/api/)" == "Basegun backend" ]]  && echo "Test ip OK"
+      - name: test DNS
+        if: success()
+        run : |
+          [[ "$(curl preprod.basegun.fr/api/)" == "Basegun backend" ]]  && echo "Test DNS OK"
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -37,6 +37,8 @@ jobs:
     - name: Build docker image for tests
       run: docker build --target test -t basegun-back:tests backend/
     - name: Start container
-      run: docker run --rm --name basegun_back_test -d basegun-back:tests
+      run: |
+        VERSION=$(cat Makefile | grep $'^TAG\t\+:= ' | sed 's/TAG\t\+:= //')
+        docker run --rm -e VERSION=$VERSION --name basegun_back_test -d basegun-back:tests
     - name: Run tests
       run: docker exec basegun_back_test python -m unittest discover -v
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -24,19 +24,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+    - name: Get the version
+      id: get_version
+      run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
     - name: Build the Docker image
-      run: TAG=action docker-compose -f docker-compose-prod.yml build
+      run: TAG=${{ steps.get_version.outputs.VERSION }} docker-compose -f docker-compose-prod.yml build
     - name: Login to GHCR
       if: success()
       uses: docker/login-action@v1
       with:
         registry: ghcr.io
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}
-    - name: Get the version
-      id: get_version
-      run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
     - name: Push on GHCR
       run: |
-        ./cd/scripts/docker-push.sh ${{ steps.get_version.outputs.VERSION }}
-        ./cd/scripts/docker-push.sh latest
+        ./cd/scripts/docker-push.sh ${{ steps.get_version.outputs.VERSION }} ${{ steps.get_version.outputs.VERSION }}
+        ./cd/scripts/docker-push.sh ${{ steps.get_version.outputs.VERSION }} latest
diff --git a/Makefile b/Makefile
@@ -2,9 +2,9 @@ SHELL	:= /bin/bash
 DOCKER	:= $(shell type -p docker)
 DC		:= $(shell type -p docker-compose)
 TAG		:= 1.2
-APP_NAME    := basegun
-REG     := ghcr.io
-ORG     := datalab-mi
+APP_NAME	:= basegun
+REG		:= ghcr.io
+ORG		:= datalab-mi
 
 
 export

diff --git a/backend/README.md b/backend/README.md
@@ -30,7 +30,7 @@ uvicorn src.main:app --reload --host 0.0.0.0 --port 5000
 
 ### With Docker
 ```bash
-docker run --rm -d -p 5000:5000 --name basegun_back basegun-back:dev -e PATH_IMGS=/tmp/basegun/
+docker run --rm -d -p 5000:5000 --name basegun_back -e VERSION=1.2 basegun-back:dev
 ```
 Remember afterwards to stop container `docker stop basegun_back`
 

diff --git a/backend/src/main.py b/backend/src/main.py
@@ -49,6 +49,14 @@ def home():
     return "Basegun backend"
 
 
+@app.get("/version", response_class=PlainTextResponse)
+def version():
+    if "VERSION" in os.environ:
+        return os.environ["VERSION"]
+    else:
+        return "-1.0"
+
+
 @app.post("/upload")
 async def imageupload(image: UploadFile = File(...)):
     if model:

diff --git a/backend/tests/test_api.py b/backend/tests/test_api.py
@@ -16,6 +16,13 @@ def test_home(self):
         r = requests.get(self.url)
         self.assertEqual(r.text, "Basegun backend")
 
+    def test_version(self):
+        """Checks that the route /version sends a version"""
+        self.assertTrue("VERSION" in os.environ)
+        r = requests.get(self.url + '/version')
+        self.assertEqual(r.text, os.environ["VERSION"])
+        self.assertEqual(len(r.text.split('.')), 2) # checks version has format X.Y
+
     def test_upload(self):
         """Checks that the file upload works properly"""
         path = os.path.join(

diff --git a/cd/scripts/docker-push.sh b/cd/scripts/docker-push.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-docker tag basegun-frontend:action-prod ghcr.io/datalab-mi/basegun/basegun-frontend:$1
-docker tag basegun-backend:action-prod ghcr.io/datalab-mi/basegun/basegun-backend:$1
-docker push ghcr.io/datalab-mi/basegun/basegun-frontend:$1
-docker push ghcr.io/datalab-mi/basegun/basegun-backend:$1
+docker tag basegun-frontend:$1-prod ghcr.io/datalab-mi/basegun/basegun-frontend:$2
+docker tag basegun-backend:$1-prod ghcr.io/datalab-mi/basegun/basegun-backend:$2
+docker push ghcr.io/datalab-mi/basegun/basegun-frontend:$2
+docker push ghcr.io/datalab-mi/basegun/basegun-backend:$2
diff --git a/docker-compose-dev.yml b/docker-compose-dev.yml
@@ -13,6 +13,7 @@ services:
     container_name: basegun-backend
     environment:
       - PATH_IMGS=/app/images
+      - VERSION=${TAG}
     image: basegun-backend:${TAG}-dev
     ports:
       - 5000:5000

diff --git a/docker-compose-prod.yml b/docker-compose-prod.yml
@@ -13,6 +13,7 @@ services:
     container_name: basegun-backend
     environment:
       - PATH_IMGS=/app/images
+      - VERSION=${TAG}
     image: basegun-backend:${TAG}-prod
     ports:
       - 5000:5000