Merge pull request #312 from canonical/chore/taskfile

chore(WD-33708): Add Taskfile on assets manager

Author: muhammad-ali-pk

.env

@@ -6,10 +6,10 @@ FLASK_APP=webapp.app
 FLASK_READ_ONLY_MODE=false
 
 # Database
-FLASK_DATABASE_URL=postgresql://assets:password@localhost:5432/assets
+FLASK_DATABASE_URL=postgresql://assets:password@postgres:5432/assets
 
 # Swift server
-FLASK_OS_AUTH_URL=http://localhost:8080/auth/v1.0
+FLASK_OS_AUTH_URL=http://swift:8080/auth/v1.0
 FLASK_OS_USERNAME=test:tester
 FLASK_OS_PASSWORD=testing
 FLASK_OS_AUTH_VERSION=1.0

.github/workflows/pr.yaml

@@ -4,31 +4,21 @@ on: pull_request
 jobs:
   run-image:
     runs-on: ubuntu-latest
-
-    services:
-      postgres:
-        image: postgres
-        env:
-          POSTGRES_DB: assets
-          POSTGRES_USER: assets
-          POSTGRES_PASSWORD: password
-        ports:
-          - 5432:5432
-      swift:
-        image: bouncestorage/swift-aio
-        ports:
-          - 8080:8080
     steps:
       - uses: actions/checkout@v3
 
-      - name: Build image
-        run: DOCKER_BUILDKIT=1 docker build --tag assets-ubuntu-com .
+      - name: Install Taskfile
+        uses: arduino/setup-task@v2
+        with:
+          version: 3.x
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run project
+        run: task && sleep 60
 
-      - name: Run image
+      - name: Ping application and verify it's running
         run: |
-          docker run --detach --env-file .env --network host assets-ubuntu-com
-          sleep 1
-          curl --head --fail --retry-delay 1 --retry 30 --retry-connrefused http://localhost
+          curl --head --fail --retry-delay 1 --retry 30 --retry-connrefused http://localhost:8017
 
   run-tests:
     runs-on: ubuntu-latest
@@ -53,6 +43,8 @@ jobs:
           sudo pip3 install dotrun requests==2.31.0 # requests version is pinned to avoid breaking changes, can be removed once issue is resolved: https://github.com/docker/docker-py/issues/3256
           chmod -R 777 .
           echo "FLASK_DISABLE_AUTH_FOR_TESTS=true" >> .env
+          echo "FLASK_DATABASE_URL=postgresql://assets:password@localhost:5432/assets" >> .env
+          echo "FLASK_OS_AUTH_URL=http://localhost:8080/auth/v1.0" >> .env
 
       - name: Install dependencies
         run: dotrun install
@@ -121,7 +113,7 @@ jobs:
       - name: Install python dependencies
         run: |
           python3 -m pip install --upgrade pip
-          sudo pip3 install flake8 black
+          sudo pip3 install flake8 black==25.1.0
 
       - name: Lint python
         run: yarn lint-python

Dockerfile

@@ -43,13 +43,23 @@ RUN yarn build
 # ===
 FROM python-dependencies AS production
 
+# Install Node.js and yarn for running lint and format commands
+RUN apt-get update && apt-get install --no-install-recommends --yes \
+    curl gnupg \
+    && curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
+    && apt-get install --no-install-recommends --yes nodejs \
+    && npm install -g yarn \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
+
 # Set up environment
 WORKDIR /srv
+ENV PATH="/srv/.venv/bin:$PATH"
 
 # Import code, build assets and mirror list
-RUN rm -rf package.json yarn.lock requirements.txt
+RUN rm -rf requirements.txt
 COPY --from=build /srv/static/css static/css
 COPY --from=build /srv/static/js/dist static/js/dist
+COPY --from=yarn-dependencies /srv/node_modules node_modules
 
 # Set revision ID
 ARG BUILD_ID

HACKING.md

@@ -9,26 +9,30 @@ We use [Yarn](https://yarnpkg.com/lang/en/) for building static files like CSS t
 1. To run the project simply, you will need to install `dotrun`, by following the [installation instructions](https://github.com/canonical/dotrun#installation)
 2. docker: Docker is used to run the project. You can install it by following the [installation instructions](https://docs.docker.com/install/)
 3. docker-compose: Docker compose is used to run the Postgres database and the SWIFT server (files server), you can install it by following the [installation instructions](https://docs.docker.com/compose/install/)
+4. [Taskfile](https://taskfile.dev/docs/installation): It is used to run everything with a single `task` command.
 
 ## Running the project
 
-### Starting the database and the SWIFT server
+Please make sure you are running the latest version of 
+- [Docker](https://docs.docker.com/engine/install/)
+- [Docker compose](https://docs.docker.com/compose/install/)
+- [Taskfile](https://taskfile.dev/docs/installation)
 
-To start the database and the SWIFT server, run:
+Starting the project with all it's services is as simple as
 
 ```bash
-docker-compose up -d
+task
 ```
 
-### Starting the project
+That's it! The project should now be running at http://localhost:8017/manager.
 
-To start the project, run:
+You can stop the project using
 
 ```bash
-dotrun
-```
+task stop
+````
 
-That's it! The project should now be running at http://localhost:8017/manager.
+Please checkout [Taskfile.yml](/Taskfile.yml) for all available commands
 
 ### Generating API tokens
 

Taskfile.yml

@@ -0,0 +1,61 @@
+version: "3"
+
+dotenv: [".env", ".env.local"]
+
+tasks:
+  default:
+    desc: "Start the project"
+    cmds:
+      - docker compose up -d
+
+  stop:
+    desc: "Stop the project"
+    cmds:
+      - docker compose down
+
+  cleanup:
+    desc: "Stop containers and remove volumes"
+    cmds:
+      - docker compose down -v
+
+  rebuild:
+    desc: "Rebuild the project. Only run this if you have made changes to the Docker related files (Dockerfile, docker-compose.yaml)."
+    cmds:
+      - docker compose up -d --build
+
+  format-python:
+    desc: "Format python code"
+    cmds:
+      - docker exec assetsubuntucom-app-1 yarn format-python
+
+  lint:
+    desc: "Run code linters"
+    cmds:
+      - docker exec assetsubuntucom-app-1 yarn lint
+
+  test-python:
+    desc: "Run tests"
+    cmds:
+      - docker exec assetsubuntucom-app-1 yarn test-python
+
+  test-e2e:
+    desc: "Run end-to-end tests"
+    cmds:
+      - docker exec assetsubuntucom-app-1 yarn playwright install
+      - docker exec assetsubuntucom-app-1 yarn test-e2e
+
+  build:
+    desc: "Build the project"
+    cmds:
+      - docker exec assetsubuntucom-app-1 yarn build
+
+  watch:
+    desc: "Watch the project"
+    cmds:
+      - docker exec assetsubuntucom-app-1 yarn watch
+
+  test:
+    desc: "Run all tests"
+    cmds:
+      - task: lint
+      - task: test-python

docker-compose.yaml

@@ -9,12 +9,39 @@ services:
       - postgres-data:/var/lib/postgresql/data
     ports:
       - "5432:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U assets -d assets"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
   swift:
     image: openstackswift/saio:latest
     ports:
       - "8080:8080"
     volumes:
       - swift-data:/srv
+  app:
+    build: .
+    env_file:
+      - path: .env
+      - path: .env.local
+        required: false
+    ports:
+      - "${PORT}:80"
+    volumes:
+      - .:/srv
+      - /srv/.venv
+    depends_on:
+      postgres:
+        condition: service_healthy
+      swift:
+        condition: service_started
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:80/manager"]
+      interval: 5s
+      timeout: 5s
+      retries: 30
+      start_period: 30s
 volumes:
   postgres-data:
   swift-data:

requirements.txt

@@ -19,4 +19,7 @@ pydantic-settings==2.10.1
 python-slugify==8.0.4
 trino==0.335.0
 google-auth==2.40.3
-cryptography==46.0.1
+cryptography==46.0.1
+setuptools==79.0.1
+black==25.1.0
+flake8==7.1.1