From eeb02c2198cb455bb53d58b1c81bb42fa5943678 Mon Sep 17 00:00:00 2001
From: Bruno Alla <browniebroke@users.noreply.github.com>
Date: Sat, 25 Feb 2023 12:33:30 +0000
Subject: [PATCH] Run linting with pre-commit on GitLab (#4150)

* Run linting with pre-commit on GitLab

* Update tests
---
 tests/test_cookiecutter_generation.py        |  6 ++++--
 {{cookiecutter.project_slug}}/.gitlab-ci.yml | 22 +++++++++++---------
 2 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/tests/test_cookiecutter_generation.py b/tests/test_cookiecutter_generation.py
index 5608bf88..7628e5e1 100755
--- a/tests/test_cookiecutter_generation.py
+++ b/tests/test_cookiecutter_generation.py
@@ -232,7 +232,7 @@ def test_travis_invokes_pytest(cookies, context, use_docker, expected_test_scrip
         ("y", "docker-compose -f local.yml run django pytest"),
     ],
 )
-def test_gitlab_invokes_flake8_and_pytest(
+def test_gitlab_invokes_precommit_and_pytest(
     cookies, context, use_docker, expected_test_script
 ):
     context.update({"ci_tool": "Gitlab", "use_docker": use_docker})
@@ -246,7 +246,9 @@ def test_gitlab_invokes_flake8_and_pytest(
     with open(f"{result.project_path}/.gitlab-ci.yml") as gitlab_yml:
         try:
             gitlab_config = yaml.safe_load(gitlab_yml)
-            assert gitlab_config["flake8"]["script"] == ["flake8"]
+            assert gitlab_config["precommit"]["script"] == [
+                "pre-commit run --show-diff-on-failure --color=always --all-files"
+            ]
             assert gitlab_config["pytest"]["script"] == [expected_test_script]
         except yaml.YAMLError as e:
             pytest.fail(e)
diff --git a/{{cookiecutter.project_slug}}/.gitlab-ci.yml b/{{cookiecutter.project_slug}}/.gitlab-ci.yml
index dbb65fb7..7892ad63 100644
--- a/{{cookiecutter.project_slug}}/.gitlab-ci.yml
+++ b/{{cookiecutter.project_slug}}/.gitlab-ci.yml
@@ -7,21 +7,26 @@ variables:
   POSTGRES_PASSWORD: ''
   POSTGRES_DB: 'test_{{ cookiecutter.project_slug }}'
   POSTGRES_HOST_AUTH_METHOD: trust
-  {% if cookiecutter.use_celery == 'y' -%}
+  {%- if cookiecutter.use_celery == 'y' %}
   CELERY_BROKER_URL: 'redis://redis:6379/0'
   {%- endif %}
 
-flake8:
+precommit:
   stage: lint
-  image: python:3.10-alpine
+  image: python:3.10
+  variables:
+    PRE_COMMIT_HOME: ${CI_PROJECT_DIR}/.cache/pre-commit
+  cache:
+    paths:
+      - ${PRE_COMMIT_HOME}
   before_script:
-    - pip install -q flake8
+    - pip install -q pre-commit
   script:
-    - flake8
+    - pre-commit run --show-diff-on-failure --color=always --all-files
 
 pytest:
   stage: test
-  {% if cookiecutter.use_docker == 'y' -%}
+  {%- if cookiecutter.use_docker == 'y' %}
   image: docker/compose:1.29.2
   tags:
     - docker
@@ -34,7 +39,7 @@ pytest:
     - docker-compose -f local.yml up -d
   script:
     - docker-compose -f local.yml run django pytest
-  {%- else -%}
+  {%- else %}
   image: python:3.10
   tags:
     - python
@@ -42,11 +47,8 @@ pytest:
     - postgres:{{ cookiecutter.postgresql_version }}
   variables:
     DATABASE_URL: pgsql://$POSTGRES_USER:$POSTGRES_PASSWORD@postgres/$POSTGRES_DB
-
   before_script:
     - pip install -r requirements/local.txt
-
   script:
     - pytest
   {%- endif %}
-