Write and setup tests with CI (GH-4)

ArtyomVancyan · web-flow · commit 57c186ca08be · 2023-03-13T13:05:29.000+04:00
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,49 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os || 'ubuntu-latest' }}
+    strategy:
+      matrix:
+        include:
+          - python: "3.6"
+            env: py36-django32
+            os: ubuntu-20.04  # 3.6 is not available on ubuntu-20.04
+          - python: "3.8"
+            env: py38-django32
+          - python: "3.10"
+            env: py310-django32
+
+          - python: "3.8"
+            env: py38-django40
+          - python: "3.9"
+            env: py39-django40
+          - python: "3.10"
+            env: py310-django40
+
+          - python: "3.9"
+            env: py39-django41
+          - python: "3.10"
+            env: py310-django41
+          - python: "3.11"
+            env: py311-django41
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          python -m pip install -e .
+          pip install tox tox-gh-actions
+      - name: Run tests using tox
+        run: tox -e ${{ matrix.env }}
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .idea
+.tox
 *.egg-info
 mermaid.js
diff --git a/README.md b/README.md
@@ -5,13 +5,35 @@ Django template tag for showing mermaid diagrams.
 [![PyPI](https://img.shields.io/pypi/v/django-mermaid.svg)](https://pypi.org/project/django-mermaid/)
 [![License](https://img.shields.io/pypi/l/django-mermaid.svg)](https://github.com/ArtyomVancyan/django-mermaid/blob/master/LICENSE)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com)
+[![Tests](https://github.com/ArtyomVancyan/django-mermaid/actions/workflows/tests.yml/badge.svg)](https://github.com/ArtyomVancyan/django-mermaid/actions/workflows/tests.yml)
 
 ## Install
 
 ```shell
 python -m pip install django-mermaid
 ```
 
+## Configuration
+
+Add the `django_mermaid.apps.MermaidConfig` to your `INSTALLED_APPS` setting:
+
+```python
+INSTALLED_APPS = [
+    ...,  # other apps
+    'django_mermaid.apps.MermaidConfig',
+]
+```
+
+## Usage
+
+Once you have installed the app, you can use the `mermaid` template tag in your templates.
+
+```html
+{% load mermaid %}
+
+{% mermaid "graph LR; A-->B;" %}
+```
+
 ## Contribute
 
 Any contribution is welcome. If you have any ideas or suggestions, feel free to open an issue or a pull request. And
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,7 @@
+[build-system]
+requires = ["setuptools>=42.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+filterwarnings = ["ignore::DeprecationWarning"]
diff --git a/setup.cfg b/setup.cfg
@@ -28,6 +28,7 @@ packages =
 install_requires =
     urllib3
     Django
+include_package_data = yes
 package_dir =
     =src
 zip_safe = no
diff --git a/setup.py b/setup.py
@@ -1,11 +1,12 @@
+from distutils import dir_util
 from os.path import dirname, join
 from urllib.request import urlretrieve
 
 from setuptools import setup
 
 if __name__ == "__main__":
-    urlretrieve(
-        "https://cdnjs.cloudflare.com/ajax/libs/mermaid/9.4.3/mermaid.js",
-        join(dirname(__file__), "src", "django_mermaid", "static", "mermaid.js")
-    )
+    cdn = "https://cdnjs.cloudflare.com/ajax/libs/mermaid/9.4.3/mermaid.js"
+    static = join(dirname(__file__), "src", "django_mermaid", "static")
+    dir_util.create_tree(static, ["mermaid.js"])
+    urlretrieve(cdn, join(static, "mermaid.js"))
     setup()
diff --git a/src/django_mermaid/__init__.py b/src/django_mermaid/__init__.py
@@ -1 +1 @@
-__version__ = "0.0.1"
+__version__ = "0.0.2"
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -0,0 +1,14 @@
+from django.conf import settings
+
+
+def pytest_configure():
+    settings.configure(
+        INSTALLED_APPS=[
+            "django_mermaid.apps.MermaidConfig"
+        ],
+        TEMPLATES=[
+            {
+                "BACKEND": "django.template.backends.django.DjangoTemplates",
+            },
+        ]
+    )
diff --git a/tests/requirements.txt b/tests/requirements.txt
@@ -0,0 +1,3 @@
+tox==3.24.3
+pytest==6.2.5
+pytest-django==4.5.2
diff --git a/tests/test_tag.py b/tests/test_tag.py
@@ -0,0 +1,29 @@
+from django.template import Context
+from django.template import Template
+
+from django_mermaid.templatetags.mermaid import mermaid
+
+
+def test_tag_renders():
+    assert mermaid("graph LR; A-->B;") == (
+        """<div class="mermaid">graph LR; A-->B;</div><script src="mermaid.js"></script>"""
+        """<script>mermaid.initialize({"startOnLoad": true, theme: "default"});</script>"""
+    )
+
+
+def test_tag_use_in_template():
+    template = Template("{% load mermaid %}{% mermaid content %}")
+    template = template.render(Context({"content": "graph LR; A-->B;"}))
+    assert template == (
+        """<div class="mermaid">graph LR; A-->B;</div><script src="mermaid.js"></script>"""
+        """<script>mermaid.initialize({"startOnLoad": true, theme: "default"});</script>"""
+    )
+
+
+def test_tag_use_in_template_with_arguments():
+    template = Template("{% load mermaid %}{% mermaid content \"forest\" %}")
+    template = template.render(Context({"content": "graph LR; A-->B;"}))
+    assert template == (
+        """<div class="mermaid">graph LR; A-->B;</div><script src="mermaid.js"></script>"""
+        """<script>mermaid.initialize({"startOnLoad": true, theme: "forest"});</script>"""
+    )
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,17 @@
+[tox]
+envlist =
+    py{36,38,310}-django32
+    py{38,39,310}-django40
+    py{39,310,311}-django{41,main}
+
+[testenv]
+deps =
+    djangomain: https://github.com/django/django/tarball/main
+    django42: django<4.3
+    django41: django<4.2
+    django40: django<4.1
+    django32: django<3.3
+    -r{toxinidir}/tests/requirements.txt
+commands =
+    pip install -e .
+    pytest

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 .idea
 +.tox
 *.egg-info
 mermaid.js
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "0.0.1"`
	`1`	`+__version__ = "0.0.2"`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+tox==3.24.3`
	`2`	`+pytest==6.2.5`
	`3`	`+pytest-django==4.5.2`