qr-code-api/Taskfile.yml at main · ToshY/qr-code-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
version: '3'

vars:
  IMAGE: toshy/qr-code-api

env:
  PUID:
    sh: id -u
  PGID:
    sh: id -g
  DOCKER_COMPOSE_RUN: docker compose --progress quiet run --rm --build --remove-orphans

tasks:
  default:
    cmds:
      - task --list

  # Docker
  build:
    desc: Build local images
    vars:
      TARGETS: [ 'dev', 'prod' ]
    cmds:
      - task: zensical:build
      - for:
          var: TARGETS
        cmd: docker buildx build --load --target {{.ITEM}} --tag {{.IMAGE}}:{{.ITEM}} .

  up:
    desc: Up service
    silent: true
    cmds:
      - docker compose up -d --remove-orphans
      - printf "Visit \033[32;4m%s\033[0m to use your application\n" "http://localhost:8000/v1/docs"

  down:
    desc: Down service
    cmds:
      - docker compose down --remove-orphans

  logs:
    desc: Show logs
    cmds:
      - docker compose logs -ft

  # Shell
  shell:dev:
    desc: Container shell
    vars:
      TARGET: 'dev'
    cmds:
      - $DOCKER_COMPOSE_RUN {{.TARGET}} {{.CLI_ARGS | default "/bin/sh"}}

  # Test
  dev:cli:
    desc: Test dev image - cli (compose)
    vars:
      OUTPUT_DIRECTORY: '{{.o | default "output"}}'
    cmds:
      - mkdir -p ${PWD}/{{.OUTPUT_DIRECTORY}}
      - $DOCKER_COMPOSE_RUN dev python -m qr generate {{.CLI_ARGS | default "--help"}}

  dev:server:
    desc: Test dev image - server (compose)
    vars:
      OUTPUT_DIRECTORY: '{{.o | default "output"}}'
    cmds:
      - mkdir -p ${PWD}/{{.OUTPUT_DIRECTORY}}
      - $DOCKER_COMPOSE_RUN dev

  prod:cli:
    desc: Test prod image (docker)
    silent: true
    vars:
      TARGET: 'prod'
      OUTPUT_DIRECTORY: '{{.o | default "output"}}'
    cmds:
      - docker buildx build --quiet --load --target {{.TARGET}} --tag {{.IMAGE}}:{{.TARGET}} .
      - mkdir -p ${PWD}/{{.OUTPUT_DIRECTORY}}
      - docker run -it -u $(id -u):$(id -g) -v ${PWD}/{{.OUTPUT_DIRECTORY}}:/app/output --rm {{.IMAGE}}:{{.TARGET}} {{.CLI_ARGS | default "--help"}}

  prod:server:
    desc: Test prod image (docker)
    silent: true
    vars:
      TARGET: 'prod'
    cmds:
      - docker buildx build --quiet --load --target {{.TARGET}} --tag {{.IMAGE}}:{{.TARGET}} .
      - docker run -it -u $(id -u):$(id -g) -p 8001:8000 --name qr-code --rm {{.IMAGE}}:{{.TARGET}} server

  # Docs
  zensical:build:
    desc: Zensical build
    cmds:
      - |
        export MAJOR_VERSION=v$(ls -1 ./docs/version | grep -E '^v[0-9]+' | sed 's/^v//' | sort -n | tail -1)
        envsubst '$MAJOR_VERSION' < zensical.toml > .zensical.runtime.toml
        docker run --rm \
          -u "$(id -u):$(id -g)" \
          -v "${PWD}:/docs" \
          zensical/zensical:0.0 \
          build -f .zensical.runtime.toml
        rm -f .zensical.runtime.toml

  zensical:live:
    desc: Zensical development server
    vars:
      PORT: '{{.p | default "8002"}}'
    cmds:
      - |
        export MAJOR_VERSION=v$(ls -1 ./docs/version | grep -E '^v[0-9]+' | sed 's/^v//' | sort -n | tail -1)
        envsubst '$MAJOR_VERSION' < zensical.toml > .zensical.runtime.toml
        trap 'rm -f .zensical.runtime.toml' EXIT
        docker run --rm \
          -u $(id -u):$(id -g) \
          -p {{.PORT}}:8000 \
          -v ${PWD}:/docs \
          zensical/zensical:0.0 \
          serve -f .zensical.runtime.toml --dev-addr=0.0.0.0:8000

  # OpenAPI
  openapi:
    desc: Retrieve OpenAPI specs
    silent: true
    vars:
      VERSION: '{{.v | default "1"}}'
    cmds:
      - |
        API_VERSION="v{{.VERSION}}"
        FILE_LOCATION="./docs/version/v{{.VERSION}}/openapi.json"
        API_URL="http://localhost:8000/$API_VERSION/openapi.json"
        curl -s $API_URL | jq . > "./docs/version/$API_VERSION/openapi.json"
        printf "File saved to \033[32;4m%s\033[0m\n" "$FILE_LOCATION"

  # Development tools
  contribute:
    desc: Contribute
    cmds:
      - task: black:fix
      - task: ruff:fix
      - task: mypy
      - task: pytest

  ruff:
    desc: Run ruff
    cmds:
      - $DOCKER_COMPOSE_RUN dev ruff check .

  ruff:fix:
    desc: Run ruff fix
    cmds:
      - $DOCKER_COMPOSE_RUN dev ruff check --fix .

  black:
    desc: Run black
    cmds:
      - $DOCKER_COMPOSE_RUN dev black . --check --diff --color

  black:fix:
    desc: Run black fix
    cmds:
      - $DOCKER_COMPOSE_RUN dev black .

  mypy:
    desc: Run mypy
    cmds:
      - $DOCKER_COMPOSE_RUN dev mypy .

  pytest:
    desc: Run pytest
    cmds:
      - $DOCKER_COMPOSE_RUN dev pytest --snapshot-update