Merge pull request rosscdh#10 from rosscdh/feature/tests

[REVIEW] added basic tests

Author: rosscdh

.gitignore

@@ -1,9 +1,12 @@
 .idea/
+venv
+.vscode/
 env/
 dist/
 build/
+test/site
 __pycache__/
 .pytest_cache/
 *.egg-info/
 
-!.gitkeep
+!.gitkeep

README.md

@@ -52,7 +52,6 @@ The paths to these become their variable names, so if inside your data folder yo
 called `sections/captions.yml`, the data inside that file will be available in your
 templates as `sections.captions`.
 
-<br/>
 
 ## Features
 
@@ -75,7 +74,11 @@ and then in your `*.md` files
 <a href="{{ customer.web }}">{{ customer.web }}</a>
 ```
 
-<br/>
+## Testing
+
+```
+pytest test
+```
 
 ## Contributing
 

shell.nix

@@ -0,0 +1,10 @@
+# for NixOS: nix-shell for locally using the plugin
+
+with import <nixpkgs> {};
+with pkgs.python3Packages;
+
+buildPythonPackage rec {
+  name = "mkdocs-markdownextradata-plugin";
+  src = ./.;
+  propagatedBuildInputs = [ ];
+}

test/docs/index.md

@@ -0,0 +1,3 @@
+Hi there, {{ customer.name }}
+
+Welcome to {{ customer.web_url }}

test/mkdocs.yml

@@ -0,0 +1,13 @@
+site_name: test markdownextradata_plugin
+use_directory_urls: true
+# theme:
+#     name: null
+#     custom_dir: 'theme/'
+plugins:
+    - search
+    - markdownextradata
+
+extra:
+  customer:
+    name: Your name here
+    web_url: www.example.com

test/test_basic.py

@@ -0,0 +1,25 @@
+import os
+import yaml
+import click
+import pytest
+import tempfile
+from pathlib import Path
+from click.testing import CliRunner
+from mkdocs.__main__ import build_command
+
+config = yaml.load(open('test/mkdocs.yml', 'rb'), Loader=yaml.Loader)
+
+def test_basic_working():
+    runner = CliRunner()
+    customer = config.get('extra', {}).get('customer', {})
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+        result = runner.invoke(build_command, ['--config-file', 'test/mkdocs.yml', '--site-dir', tmpdir])
+        assert result.exit_code == 0
+
+        index_file = Path(tmpdir) / 'index.html'
+        assert index_file.exists(),  f"{index_file} does not exist, it should"
+        contents = index_file.read_text()
+
+        assert f"Hi there, {customer.get('name')}" in contents, f"customer.name is not in index"
+        assert f"Welcome to {customer.get('web_url')}" in contents, f"customer.web_url is not in index"