Overhaul tests to use py.test

Author: akx

.github/workflows/run_tests.yaml

@@ -18,18 +18,53 @@ jobs:
           cache-dependency-path: |
             **/requirements*txt
             launch.py
-      - name: Run tests
-        run: python launch.py --tests test --no-half --disable-opt-split-attention --use-cpu all --skip-torch-cuda-test
+      - name: Install test dependencies
+        run: pip install wait-for-it -r requirements-test.txt
+        env:
+          PIP_DISABLE_PIP_VERSION_CHECK: "1"
+          PIP_PROGRESS_BAR: "off"
+      - name: Setup environment
+        run: python launch.py --skip-torch-cuda-test --exit
         env:
           PIP_DISABLE_PIP_VERSION_CHECK: "1"
           PIP_PROGRESS_BAR: "off"
           TORCH_INDEX_URL: https://download.pytorch.org/whl/cpu
           WEBUI_LAUNCH_LIVE_OUTPUT: "1"
-      - name: Upload main app stdout-stderr
+          PYTHONUNBUFFERED: "1"
+      - name: Start test server
+        run: >
+          python -m coverage run
+          --data-file=.coverage.server
+          launch.py
+          --skip-prepare-environment
+          --skip-torch-cuda-test
+          --test-server
+          --no-half
+          --disable-opt-split-attention
+          --use-cpu all
+          --add-stop-route
+          2>&1 | tee output.txt &
+      - name: Run tests
+        run: |
+          wait-for-it --service 127.0.0.1:7860 -t 600
+          python -m pytest -vv --junitxml=test/results.xml --cov . --cov-report=xml --verify-base-url test
+      - name: Kill test server
+        if: always()
+        run: curl -vv -XPOST http://127.0.0.1:7860/_stop && sleep 10
+      - name: Show coverage
+        run: |
+          python -m coverage combine .coverage*
+          python -m coverage report -i
+          python -m coverage html -i
+      - name: Upload main app output
+        uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: output
+          path: output.txt
+      - name: Upload coverage HTML
         uses: actions/upload-artifact@v3
         if: always()
         with:
-          name: stdout-stderr
-          path: |
-            test/stdout.txt
-            test/stderr.txt
+          name: htmlcov
+          path: htmlcov

.gitignore

@@ -35,4 +35,5 @@ notification.mp3
 /cache.json*
 /config_states/
 /node_modules
-/package-lock.json
+/package-lock.json
+/.coverage*

launch.py

@@ -310,12 +310,8 @@ def prepare_environment():
         print("Exiting because of --exit argument")
         exit(0)
 
-    if args.tests and not args.no_tests:
-        exitcode = tests(args.tests)
-        exit(exitcode)
 
-
-def tests(test_dir):
+def configure_for_tests():
     if "--api" not in sys.argv:
         sys.argv.append("--api")
     if "--ckpt" not in sys.argv:
@@ -325,21 +321,8 @@ def tests(test_dir):
         sys.argv.append("--skip-torch-cuda-test")
     if "--disable-nan-check" not in sys.argv:
         sys.argv.append("--disable-nan-check")
-    if "--no-tests" not in sys.argv:
-        sys.argv.append("--no-tests")
-
-    print(f"Launching Web UI in another process for testing with arguments: {' '.join(sys.argv[1:])}")
 
     os.environ['COMMANDLINE_ARGS'] = ""
-    with open(os.path.join(script_path, 'test/stdout.txt'), "w", encoding="utf8") as stdout, open(os.path.join(script_path, 'test/stderr.txt'), "w", encoding="utf8") as stderr:
-        proc = subprocess.Popen([sys.executable, *sys.argv], stdout=stdout, stderr=stderr)
-
-    import test.server_poll
-    exitcode = test.server_poll.run_tests(proc, test_dir)
-
-    print(f"Stopping Web UI process with id {proc.pid}")
-    proc.kill()
-    return exitcode
 
 
 def start():
@@ -351,6 +334,15 @@ def start():
         webui.webui()
 
 
-if __name__ == "__main__":
-    prepare_environment()
+def main():
+    if not args.skip_prepare_environment:
+        prepare_environment()
+
+    if args.test_server:
+        configure_for_tests()
+
     start()
+
+
+if __name__ == "__main__":
+    main()

modules/cmd_args.py

@@ -12,8 +12,8 @@
 parser.add_argument("--reinstall-xformers", action='store_true', help="launch.py argument: install the appropriate version of xformers even if you have some version already installed")
 parser.add_argument("--reinstall-torch", action='store_true', help="launch.py argument: install the appropriate version of torch even if you have some version already installed")
 parser.add_argument("--update-check", action='store_true', help="launch.py argument: chck for updates at startup")
-parser.add_argument("--tests", type=str, default=None, help="launch.py argument: run tests in the specified directory")
-parser.add_argument("--no-tests", action='store_true', help="launch.py argument: do not run tests even if --tests option is specified")
+parser.add_argument("--test-server", action='store_true', help="launch.py argument: configure server for testing")
+parser.add_argument("--skip-prepare-environment", action='store_true', help="launch.py argument: skip all environment preparation")
 parser.add_argument("--skip-install", action='store_true', help="launch.py argument: skip installation of packages")
 parser.add_argument("--data-dir", type=str, default=os.path.dirname(os.path.dirname(os.path.realpath(__file__))), help="base path where all user data is stored")
 parser.add_argument("--config", type=str, default=sd_default_config, help="path to config which constructs model",)

pyproject.toml

@@ -30,3 +30,6 @@ ignore = [
 [tool.ruff.flake8-bugbear]
 # Allow default arguments like, e.g., `data: List[str] = fastapi.Query(None)`.
 extend-immutable-calls = ["fastapi.Depends", "fastapi.security.HTTPBasic"]
+
+[tool.pytest.ini_options]
+base_url = "http://127.0.0.1:7860"

requirements-test.txt

@@ -0,0 +1,3 @@
+pytest-base-url~=2.0
+pytest-cov~=4.0
+pytest~=7.3

test/basic_features/__init__.py

@@ -0,0 +1,17 @@
+import os
+
+import pytest
+from PIL import Image
+from gradio.processing_utils import encode_pil_to_base64
+
+test_files_path = os.path.dirname(__file__) + "/test_files"
+
+
+@pytest.fixture(scope="session")  # session so we don't read this over and over
+def img2img_basic_image_base64() -> str:
+    return encode_pil_to_base64(Image.open(os.path.join(test_files_path, "img2img_basic.png")))
+
+
+@pytest.fixture(scope="session")  # session so we don't read this over and over
+def mask_basic_image_base64() -> str:
+    return encode_pil_to_base64(Image.open(os.path.join(test_files_path, "mask_basic.png")))

test/basic_features/extras_test.py

@@ -0,0 +1,35 @@
+import requests
+
+
+def test_simple_upscaling_performed(base_url, img2img_basic_image_base64):
+    payload = {
+        "resize_mode": 0,
+        "show_extras_results": True,
+        "gfpgan_visibility": 0,
+        "codeformer_visibility": 0,
+        "codeformer_weight": 0,
+        "upscaling_resize": 2,
+        "upscaling_resize_w": 128,
+        "upscaling_resize_h": 128,
+        "upscaling_crop": True,
+        "upscaler_1": "Lanczos",
+        "upscaler_2": "None",
+        "extras_upscaler_2_visibility": 0,
+        "image": img2img_basic_image_base64,
+    }
+    assert requests.post(f"{base_url}/sdapi/v1/extra-single-image", json=payload).status_code == 200
+
+
+def test_png_info_performed(base_url, img2img_basic_image_base64):
+    payload = {
+        "image": img2img_basic_image_base64,
+    }
+    assert requests.post(f"{base_url}/sdapi/v1/extra-single-image", json=payload).status_code == 200
+
+
+def test_interrogate_performed(base_url, img2img_basic_image_base64):
+    payload = {
+        "image": img2img_basic_image_base64,
+        "model": "clip",
+    }
+    assert requests.post(f"{base_url}/sdapi/v1/extra-single-image", json=payload).status_code == 200

test/basic_features/img2img_test.py

@@ -0,0 +1,68 @@
+
+import pytest
+import requests
+
+
+@pytest.fixture()
+def url_img2img(base_url):
+    return f"{base_url}/sdapi/v1/img2img"
+
+
+@pytest.fixture()
+def simple_img2img_request(img2img_basic_image_base64):
+    return {
+        "batch_size": 1,
+        "cfg_scale": 7,
+        "denoising_strength": 0.75,
+        "eta": 0,
+        "height": 64,
+        "include_init_images": False,
+        "init_images": [img2img_basic_image_base64],
+        "inpaint_full_res": False,
+        "inpaint_full_res_padding": 0,
+        "inpainting_fill": 0,
+        "inpainting_mask_invert": False,
+        "mask": None,
+        "mask_blur": 4,
+        "n_iter": 1,
+        "negative_prompt": "",
+        "override_settings": {},
+        "prompt": "example prompt",
+        "resize_mode": 0,
+        "restore_faces": False,
+        "s_churn": 0,
+        "s_noise": 1,
+        "s_tmax": 0,
+        "s_tmin": 0,
+        "sampler_index": "Euler a",
+        "seed": -1,
+        "seed_resize_from_h": -1,
+        "seed_resize_from_w": -1,
+        "steps": 3,
+        "styles": [],
+        "subseed": -1,
+        "subseed_strength": 0,
+        "tiling": False,
+        "width": 64,
+    }
+
+
+def test_img2img_simple_performed(url_img2img, simple_img2img_request):
+    assert requests.post(url_img2img, json=simple_img2img_request).status_code == 200
+
+
+def test_inpainting_masked_performed(url_img2img, simple_img2img_request, mask_basic_image_base64):
+    simple_img2img_request["mask"] = mask_basic_image_base64
+    assert requests.post(url_img2img, json=simple_img2img_request).status_code == 200
+
+
+def test_inpainting_with_inverted_masked_performed(url_img2img, simple_img2img_request, mask_basic_image_base64):
+    simple_img2img_request["mask"] = mask_basic_image_base64
+    simple_img2img_request["inpainting_mask_invert"] = True
+    assert requests.post(url_img2img, json=simple_img2img_request).status_code == 200
+
+
+def test_img2img_sd_upscale_performed(url_img2img, simple_img2img_request):
+    simple_img2img_request["script_name"] = "sd upscale"
+    simple_img2img_request["script_args"] = ["", 8, "Lanczos", 2.0]
+    assert requests.post(url_img2img, json=simple_img2img_request).status_code == 200

test/basic_features/txt2img_test.py

@@ -0,0 +1,90 @@
+
+import pytest
+import requests
+
+
+@pytest.fixture()
+def url_txt2img(base_url):
+    return f"{base_url}/sdapi/v1/txt2img"
+
+
+@pytest.fixture()
+def simple_txt2img_request():
+    return {
+        "batch_size": 1,
+        "cfg_scale": 7,
+        "denoising_strength": 0,
+        "enable_hr": False,
+        "eta": 0,
+        "firstphase_height": 0,
+        "firstphase_width": 0,
+        "height": 64,
+        "n_iter": 1,
+        "negative_prompt": "",
+        "prompt": "example prompt",
+        "restore_faces": False,
+        "s_churn": 0,
+        "s_noise": 1,
+        "s_tmax": 0,
+        "s_tmin": 0,
+        "sampler_index": "Euler a",
+        "seed": -1,
+        "seed_resize_from_h": -1,
+        "seed_resize_from_w": -1,
+        "steps": 3,
+        "styles": [],
+        "subseed": -1,
+        "subseed_strength": 0,
+        "tiling": False,
+        "width": 64,
+    }
+
+
+def test_txt2img_simple_performed(url_txt2img, simple_txt2img_request):
+    assert requests.post(url_txt2img, json=simple_txt2img_request).status_code == 200
+
+
+def test_txt2img_with_negative_prompt_performed(url_txt2img, simple_txt2img_request):
+    simple_txt2img_request["negative_prompt"] = "example negative prompt"
+    assert requests.post(url_txt2img, json=simple_txt2img_request).status_code == 200
+
+
+def test_txt2img_with_complex_prompt_performed(url_txt2img, simple_txt2img_request):
+    simple_txt2img_request["prompt"] = "((emphasis)), (emphasis1:1.1), [to:1], [from::2], [from:to:0.3], [alt|alt1]"
+    assert requests.post(url_txt2img, json=simple_txt2img_request).status_code == 200
+
+
+def test_txt2img_not_square_image_performed(url_txt2img, simple_txt2img_request):
+    simple_txt2img_request["height"] = 128
+    assert requests.post(url_txt2img, json=simple_txt2img_request).status_code == 200
+
+
+def test_txt2img_with_hrfix_performed(url_txt2img, simple_txt2img_request):
+    simple_txt2img_request["enable_hr"] = True
+    assert requests.post(url_txt2img, json=simple_txt2img_request).status_code == 200
+
+
+def test_txt2img_with_tiling_performed(url_txt2img, simple_txt2img_request):
+    simple_txt2img_request["tiling"] = True
+    assert requests.post(url_txt2img, json=simple_txt2img_request).status_code == 200
+
+
+def test_txt2img_with_restore_faces_performed(url_txt2img, simple_txt2img_request):
+    simple_txt2img_request["restore_faces"] = True
+    assert requests.post(url_txt2img, json=simple_txt2img_request).status_code == 200
+
+
+@pytest.mark.parametrize("sampler", ["PLMS", "DDIM", "UniPC"])
+def test_txt2img_with_vanilla_sampler_performed(url_txt2img, simple_txt2img_request, sampler):
+    simple_txt2img_request["sampler_index"] = sampler
+    assert requests.post(url_txt2img, json=simple_txt2img_request).status_code == 200
+
+
+def test_txt2img_multiple_batches_performed(url_txt2img, simple_txt2img_request):
+    simple_txt2img_request["n_iter"] = 2
+    assert requests.post(url_txt2img, json=simple_txt2img_request).status_code == 200
+
+
+def test_txt2img_batch_performed(url_txt2img, simple_txt2img_request):
+    simple_txt2img_request["batch_size"] = 2
+    assert requests.post(url_txt2img, json=simple_txt2img_request).status_code == 200

test/basic_features/utils_test.py

@@ -0,0 +1,33 @@
+import pytest
+import requests
+
+
+def test_options_write(base_url):
+    url_options = f"{base_url}/sdapi/v1/options"
+    response = requests.get(url_options)
+    assert response.status_code == 200
+
+    pre_value = response.json()["send_seed"]
+
+    assert requests.post(url_options, json={'send_seed': (not pre_value)}).status_code == 200
+
+    response = requests.get(url_options)
+    assert response.status_code == 200
+    assert response.json()['send_seed'] == (not pre_value)
+
+    requests.post(url_options, json={"send_seed": pre_value})
+
+
+@pytest.mark.parametrize("url", [
+    "sdapi/v1/cmd-flags",
+    "sdapi/v1/samplers",
+    "sdapi/v1/upscalers",
+    "sdapi/v1/sd-models",
+    "sdapi/v1/hypernetworks",
+    "sdapi/v1/face-restorers",
+    "sdapi/v1/realesrgan-models",
+    "sdapi/v1/prompt-styles",
+    "sdapi/v1/embeddings",
+])
+def test_get_api_url(base_url, url):
+    assert requests.get(f"{base_url}/{url}").status_code == 200