Nix shell for testing (#97)

* Test build using nix-shell --pure

* Update node packages and nix dependencies

* Add geckodriver and tests pass in nix-shell

* Update conda and pip test requirements

* Ensure curl and libcurl for testing

* Use new setup-micromamba action

* Relax python and curl version pins to get latest patch versions

* Use latest micromamba

* Exact setup-micromamba versions

* Exact setup-micromamba version v1.4.4

* Use the last version of old micromamba action

* Let conda install pycurl

* Relax pycurl version

* Limit to selenium v3 and urllib v1 for tests

* Comment out pycurl

* Upg actions/checkout and setup-node

Author: ashwinvis

.github/workflows/nodejs.yml

@@ -30,10 +30,10 @@ jobs:
         shell: bash -l {0}
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
 
@@ -58,11 +58,11 @@ jobs:
         CI: true
 
     - name: Install mamba
-      uses: mamba-org/provision-with-micromamba@v12
+      uses: mamba-org/provision-with-micromamba@v16
       with:
         environment-file: tests/environment.yml
 
     - name: Fine grained tests
       run: |
         micromamba activate instant-markdown
-        python -m pytest --log-cli-level=info
+        python -m pytest

CONTRIBUTING.md

@@ -6,16 +6,16 @@ Ensure that prefix points to somewhere you have access to (such as the home dire
 
 Read more on [how to configure `npm`'s paths](https://stackoverflow.com/a/13021677).
 
-    npm install -g .
     npm install
+    npm link .
 
 ## Testing
 
 Simple integration test
 
     npm run test
 
-Fine grained tests with checks for output requires Python, Firefox and geckodriver.
+Fine grained tests with checks for output requires Python, Firefox and geckodriver.    
 
     python -m venv venv && source venv/bin/activate && pip install -r tests/requirements.txt
     pytest --log-cli-level=info

default.nix

@@ -0,0 +1,23 @@
+{
+  pkgs ? import <nixpkgs> {}
+}:
+
+pkgs.mkShell {
+    name = "instant-markdown-d";
+    # nativeBuildInputs is usually what you want -- tools you need to run
+    nativeBuildInputs = with pkgs.buildPackages; [
+      nodePackages.npm
+      git
+      geckodriver
+    ];
+    # libs
+    buildInputs = with pkgs; [
+      nodejs-slim-12_x
+    ];
+    shellHook = ''
+      npm install .
+      ln -rsf ./src/cli.js node_modules/.bin/instant-markdown-d
+      export PATH="$PWD/node_modules/.bin:$PATH"
+    '';
+}
+

package.json

@@ -25,14 +25,14 @@
   },
   "dependencies": {
     "highlight.js": "^10.4.1",
-    "markdown-it": "^8.4.2",
+    "markdown-it": "^13.0.1",
     "markdown-it-mathjax": "^2.0.0",
     "markdown-it-task-lists": "^2.1.1",
     "markdown-it-front-matter": "^0.2.3",
     "markdown-it-textual-uml": "^0.1.3",
     "mathjax": "^2.7.5",
-    "mathjax-node-page": "^3.0.2",
-    "mermaid": "^8.9.0",
+    "mathjax-node-page": "^1.4.0",
+    "mermaid": "^9.1.1",
     "minimist": "^1.2.5",
     "send": "~0.17.1",
     "socket.io": "^3.0.4"

pytest.ini

@@ -1,4 +1,5 @@
 [pytest]
+log_cli_level=info
 log_format = %(asctime)s %(levelname)s %(filename)s:%(lineno)03d::%(funcName)-20s %(message)s
 log_date_format = %H:%M:%S
 addopts = --reruns 3 --reruns-delay 2

tests/conftest.py

@@ -13,6 +13,9 @@
 from selenium.webdriver.support.ui import WebDriverWait
 
 logger = logging.getLogger("instant-markdown-d_tests")
+logger.setLevel(logging.INFO)
+# logger = logging
+# logging.basicConfig(level=logging.INFO)
 
 
 def port_in_use(port):
@@ -93,7 +96,11 @@ def __init__(self, options, port=8090):
 
     def __enter__(self):
         node = which("node")
+        if not node:
+            raise OSError("Node.js is not installed.")
+
         cmd = [node, "./src/cli.js", *self.options]
+        assert all(isinstance(c, str) for c in cmd)
         logger.info(f"Running {' '.join(cmd)}")
         self.process = subprocess.Popen(
             cmd,
@@ -165,3 +172,14 @@ def browser():
 @pytest.fixture(scope="function")
 def Server():
     return InstantMarkdownD
+
+
+if __name__ == "__main__":
+    # Run
+    #   python tests/conftest.py
+    # to ensure all fixtures work
+    with BrowserEngine():
+        pass
+
+    with InstantMarkdownD(""):
+        pass

tests/environment.yml

@@ -3,11 +3,10 @@ channels:
   - conda-forge
   - defaults
 dependencies:
-  - firefox=89.0
-  - geckodriver=0.29.0
-  - pycurl=7.43.0.6
-  - pytest=6.2.4
-  - pytest-rerunfailures=10.0
-  - python=3.9.4
-  - selenium=3.141.0
-  - wheel=0.36.2
+  - firefox=115.2.1esr
+  - geckodriver=0.33.0
+  - python=3.9
+  - curl=8.3
+  - pycurl=7
+  - pip:
+    - -r requirements.txt

tests/requirements.in

@@ -1,5 +1,5 @@
-wheel
-selenium
+selenium<4
+urllib3<2
 pytest
 pytest-rerunfailures
-pycurl
+# pycurl

tests/requirements.txt

@@ -1,37 +1,30 @@
 #
-# This file is autogenerated by pip-compile
+# This file is autogenerated by pip-compile with python 3.9
 # To update, run:
 #
 #    pip-compile
 #
-attrs==21.2.0
+exceptiongroup==1.1.3
     # via pytest
-iniconfig==1.1.1
+iniconfig==2.0.0
     # via pytest
-packaging==20.9
-    # via pytest
-pluggy==0.13.1
-    # via pytest
-py==1.10.0
+packaging==23.1
+    # via
+    #   pytest
+    #   pytest-rerunfailures
+pluggy==1.3.0
     # via pytest
-pycurl==7.43.0.6
-    # via -r requirements.in
-pyparsing==2.4.7
-    # via packaging
-pytest==6.2.4
+pytest==7.4.2
     # via
     #   -r requirements.in
     #   pytest-rerunfailures
-pytest-rerunfailures==10.0
+pytest-rerunfailures==12.0
     # via -r requirements.in
 selenium==3.141.0
     # via -r requirements.in
-toml==0.10.2
+tomli==2.0.1
     # via pytest
-urllib3==1.26.5
-    # via selenium
-wheel==0.38.1
-    # via -r requirements.in
-
-# The following packages are considered to be unsafe in a requirements file:
-# setuptools
+urllib3==1.26.16
+    # via
+    #   -r requirements.in
+    #   selenium