Fix Installation Check to catch uninstalled module errors (#715)

* Update ci_nox.py

* update the check_install command to use a virtual env for fidesctl

* fix the API_PREFIX references

* set the API util to reuse the API_PREFIX from the core utils

* fix isort

* update the changelog

CHANGELOG.md

@@ -55,6 +55,7 @@ The types of changes are:
 * Updated the webserver so that it won't fail if the database is inaccessible [#649](https://github.com/ethyca/fides/pull/649)
 * Handle complex characters in external tests  [#661](https://github.com/ethyca/fides/pull/661)
 * Evaluations now properly merge the default taxonomy into the user-defined taxonomy [#684](https://github.com/ethyca/fides/pull/684)
+* The CLI can be run without installing the webserver components [#715](https://github.com/ethyca/fides/pull/715)
 
 ## [1.6.0](https://github.com/ethyca/fides/compare/1.5.3...1.6.0) - 2022-05-02
 

noxfiles/ci_nox.py

@@ -110,11 +110,9 @@ def xenon(session: nox.Session) -> None:
 @nox.session()
 def check_install(session: nox.Session) -> None:
     """Check that fidesctl is installed."""
-    if session.posargs == ["docker"]:
-        run_command = (*RUN_STATIC_ANALYSIS, "check_install")
-    else:
-        run_command = ("fidesctl", *(WITH_TEST_CONFIG), "--version")
-    session.run(*run_command, external=True)
+    session.install(".")
+    run_command = ("fidesctl", *(WITH_TEST_CONFIG), "--version")
+    session.run(*run_command)
 
 
 @nox.session()

src/fidesapi/routes/util.py

@@ -5,7 +5,9 @@
 
 from fastapi import APIRouter
 
-API_PREFIX = "/api/v1"
+from fidesctl.core.utils import API_PREFIX as _API_PREFIX
+
+API_PREFIX = _API_PREFIX
 WEBAPP_DIRECTORY = Path("src/fidesapi/build/static")
 WEBAPP_INDEX = WEBAPP_DIRECTORY / "index.html"
 

src/fidesctl/cli/utils.py

@@ -22,7 +22,6 @@
 )
 
 import fidesctl
-from fidesapi.routes.util import API_PREFIX
 from fidesctl.core import api as _api
 from fidesctl.core.config import FidesctlConfig
 from fidesctl.core.config.credentials_settings import (
@@ -31,7 +30,7 @@
     get_config_okta_credentials,
 )
 from fidesctl.core.config.utils import get_config_from_file, update_config_file
-from fidesctl.core.utils import check_response, echo_green, echo_red
+from fidesctl.core.utils import API_PREFIX, check_response, echo_green, echo_red
 
 
 def check_server(cli_version: str, server_url: str, quiet: bool = False) -> None:

src/fidesctl/core/api.py

@@ -3,7 +3,7 @@
 
 import requests
 
-from fidesapi.routes.util import API_PREFIX
+from fidesctl.core.utils import API_PREFIX
 
 
 def generate_resource_url(

src/fidesctl/core/utils.py

@@ -16,6 +16,10 @@
 echo_red = partial(click.secho, fg="red", bold=True)
 echo_green = partial(click.secho, fg="green", bold=True)
 
+# This duplicates a constant in `fidesapi/routes/utils.py`
+# To avoid import errors
+API_PREFIX = "/api/v1"
+
 
 def check_response(response: requests.Response) -> requests.Response:
     """

tests/cli/test_cli_utils.py

@@ -4,8 +4,8 @@
 from requests_mock import Mocker
 
 import fidesctl.cli.utils as utils
-from fidesapi.routes.util import API_PREFIX
 from fidesctl.core.config import FidesctlConfig
+from fidesctl.core.utils import API_PREFIX
 
 
 @pytest.mark.unit

tests/core/test_api.py

@@ -10,9 +10,9 @@
 from starlette.testclient import TestClient
 
 from fidesapi import main
-from fidesapi.routes.util import API_PREFIX
 from fidesctl.core import api as _api
 from fidesctl.core.config import FidesctlConfig
+from fidesctl.core.utils import API_PREFIX
 
 
 @pytest.fixture()