chore: re-organise test app

- move example to test/testapp - consolidate tests in one location
torchbox · May 12, 2023 · 2c83b3f · 2c83b3f
1 parent f0b73e5
commit 2c83b3f
Show file tree

Hide file tree

Showing 60 changed files with 987 additions and 1,550 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -43,26 +43,29 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
+          cache-dependency-path: |
+            tests/requirements.txt
 
       - name: Install Dependencies
         run: |
-          pip install -r requirements.txt
-          pip install .
+          cd tests
+          python -m pip install --upgrade pip
+          python -m pip install -r requirements.txt
 
       - name: Install Wagtail package
         if: ${{ matrix.wagtail-version != 'main' }}
         run: |
-          pip install wagtail==${{ matrix.wagtail-version }}
+          python -m pip install wagtail==${{ matrix.wagtail-version }}
 
       - name: Install Wagtail main
         if: ${{ matrix.wagtail-version == 'main' }}
         run: |
           git clone https://github.com/wagtail/wagtail.git
-          pip install ./wagtail
+          python -m pip install ./wagtail
 
       - name: Run Tests
         run: |
-          cd example
+          cd tests
           python manage.py migrate
           python manage.py test
 
@@ -76,15 +79,16 @@ jobs:
           python-version: 3.8
           cache: 'pip'
           cache-dependency-path: |
-            requirements-channels.txt
+            tests/requirements-channels.txt
 
       - name: Install Dependencies
         run: |
-          pip install -r requirements-channels.txt
-          pip install .
+          cd tests
+          python -m pip install --upgrade pip
+          python -m pip install -r requirements-channels.txt
 
       - name: Run Tests
         run: |
-          cd example
+          cd tests
           python manage.py migrate
           python manage.py test
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,6 @@
 ### Django ###
 *.log
 *.pot
-*.pyc
 __pycache__/
 local_settings.py
 media
@@ -139,3 +138,7 @@ Temporary Items
 *.sublime-workspace
 .vscode
 .idea
+
+
+# wagtail
+static/
diff --git a/README.md b/README.md
@@ -175,23 +175,22 @@ Any contributions [you make](https://github.com/torchbox/wagtail-grapple/graphs/
 
 ### Local development
 
-#### With SQLite
--   In the Python environment of your choice, navigate to `/example`
--   Run `pip install -r requirements.txt`
--   Run `./manage.py migrate`
--   Run server `./manage.py runserver`
--   Run tests `./manage.py test`
+-   In the Python environment of your choice, navigate to `tests/`
+-   Run `python -m pip install -r requirements.txt`
+-   Run `python manage.py migrate`
+-   Run server `python manage.py runserver`
+-   Run tests `python manage.py test`
 
 #### With Postgres
 
--   In the Python environment of your choice, navigate to `/example`
--   Run `pip install -r requirements.txt`
 -   Ensure you have docker and docker compose
 -   Run `docker compose up`
 -   Run `export DATABASE_URL="postgres://postgres:postgres@localhost/postgres"`
--   Run `./manage.py migrate`
--   Run server `./manage.py runserver`
--   Run tests `./manage.py test`
+-   In the Python environment of your choice, navigate to `tests/`
+-   Run `python -m pip install -r requirements.txt`
+-   Run `python manage.py migrate`
+-   Run server `python manage.py runserver`
+-   Run tests `python manage.py test`
 
 ## Compatibility
 

diff --git a/example/documents/migrations/0001_initial.py b/example/documents/migrations/0001_initial.py
diff --git a/example/documents/models.py b/example/documents/models.py
diff --git a/example/example/__init__.py b/example/example/__init__.py
diff --git a/example/example/settings/__init__.py b/example/example/settings/__init__.py
diff --git a/example/example/settings/dev.py b/example/example/settings/dev.py
diff --git a/example/example/settings/production.py b/example/example/settings/production.py
diff --git a/example/example/static/css/example.css b/example/example/static/css/example.css
diff --git a/example/example/static/js/example.js b/example/example/static/js/example.js
diff --git a/example/example/tests/__init__.py b/example/example/tests/__init__.py
diff --git a/example/home/__init__.py b/example/home/__init__.py