Add content validator

README.md

@@ -10,9 +10,9 @@
 
 You can run the following validators as subcommands (e.g. `spectacles sql`):
 
-- [**SQL** validation](https://docs.spectacles.dev/tutorials/validators#the-sql-validator) - tests for database errors or invalid SQL
-- [**Assert** validation](https://docs.spectacles.dev/tutorials/validators#the-assert-validator) - runs [LookML/data tests](https://docs.looker.com/reference/model-params/test)
-- **Content** validation _(coming soon)_
+- [**SQL** validation](https://docs.spectacles.dev/tutorials/validators#the-sql-validator) - tests the `sql` field of each dimension for database errors
+- [**Assert** validation](https://docs.spectacles.dev/tutorials/validators#the-assert-validator) - runs [Looker data tests](https://docs.looker.com/reference/model-params/test)
+- [**Content** validation](https://docs.spectacles.dev/tutorials/validators#the-content-validator) - tests for errors in Looks and Dashboards
 - **Linting** _(coming soon)_
 
 ## Documentation

spectacles/cli.py

@@ -18,6 +18,7 @@
 from spectacles.logger import GLOBAL_LOGGER as logger, set_file_handler
 import spectacles.printer as printer
 import spectacles.tracking as tracking
+from spectacles.utils import log_duration
 
 
 class ConfigFileAction(argparse.Action):
@@ -255,6 +256,23 @@ def main():
             args.import_projects,
             args.commit_ref,
         )
+    elif args.command == "content":
+        run_content(
+            args.project,
+            args.branch,
+            args.explores,
+            args.exclude,
+            args.base_url,
+            args.client_id,
+            args.client_secret,
+            args.port,
+            args.api_version,
+            args.remote_reset,
+            args.import_projects,
+            args.commit_ref,
+            args.incremental,
+            args.exclude_personal,
+        )
 
     if not args.do_not_track:
         tracking.track_invocation_end(
@@ -281,6 +299,7 @@ def create_parser() -> argparse.ArgumentParser:
     _build_connect_subparser(subparser_action, base_subparser)
     _build_sql_subparser(subparser_action, base_subparser)
     _build_assert_subparser(subparser_action, base_subparser)
+    _build_content_subparser(subparser_action, base_subparser)
     return parser
 
 
@@ -517,13 +536,93 @@ def _build_assert_subparser(
     _build_validator_subparser(subparser_action, subparser)
 
 
+def _build_content_subparser(
+    subparser_action: argparse._SubParsersAction,
+    base_subparser: argparse.ArgumentParser,
+) -> None:
+    subparser = subparser_action.add_parser(
+        "content", parents=[base_subparser], help="Run Looker content validation."
+    )
+
+    subparser.add_argument(
+        "--incremental",
+        action="store_true",
+        help="Only display errors which are not present on the master branch.",
+    )
+
+    subparser.add_argument(
+        "--exclude-personal",
+        action="store_true",
+        help="Exclude errors found in content in personal folders.",
+    )
+
+    _build_validator_subparser(subparser_action, subparser)
+
+
 def run_connect(
     base_url: str, client_id: str, client_secret: str, port: int, api_version: float
 ) -> None:
     """Tests the connection and credentials for the Looker API."""
     LookerClient(base_url, client_id, client_secret, port, api_version)
 
 
+@log_duration
+def run_content(
+    project,
+    branch,
+    explores,
+    excludes,
+    base_url,
+    client_id,
+    client_secret,
+    port,
+    api_version,
+    remote_reset,
+    import_projects,
+    commit_ref,
+    incremental,
+    exclude_personal,
+) -> None:
+    runner = Runner(
+        base_url,
+        project,
+        branch,
+        client_id,
+        client_secret,
+        port,
+        api_version,
+        remote_reset,
+        import_projects,
+        commit_ref,
+    )
+    results = runner.validate_content(explores, excludes, incremental, exclude_personal)
+
+    for test in sorted(results["tested"], key=lambda x: (x["model"], x["explore"])):
+        message = f"{test['model']}.{test['explore']}"
+        printer.print_validation_result(passed=test["passed"], source=message)
+
+    errors = sorted(
+        results["errors"],
+        key=lambda x: (x["model"], x["explore"], x["metadata"]["field_name"]),
+    )
+    if errors:
+        for error in errors:
+            printer.print_content_error(
+                error["model"],
+                error["explore"],
+                error["message"],
+                error["metadata"]["content_type"],
+                error["metadata"]["space"],
+                error["metadata"]["title"],
+                error["metadata"]["url"],
+            )
+        logger.info("")
+        raise GenericValidationError
+    else:
+        logger.info("")
+
+
+@log_duration
 def run_assert(
     project,
     branch,
@@ -571,6 +670,7 @@ def run_assert(
         logger.info("")
 
 
+@log_duration
 def run_sql(
     log_dir,
     project,
@@ -608,6 +708,11 @@ def iter_errors(lookml: List) -> Iterable:
                 yield item
 
     results = runner.validate_sql(explores, exclude, mode, concurrency)
+
+    for test in sorted(results["tested"], key=lambda x: (x["model"], x["explore"])):
+        message = f"{test['model']}.{test['explore']}"
+        printer.print_validation_result(passed=test["passed"], source=message)
+
     errors = sorted(
         results["errors"],
         key=lambda x: (x["model"], x["explore"], x["metadata"].get("dimension")),
@@ -626,9 +731,13 @@ def iter_errors(lookml: List) -> Iterable:
             )
         if mode == "batch":
             logger.info(
-                f"\n\nTo determine the exact dimensions responsible for {'this error' if len(errors) == 1 else 'these errors'}, "
-                f"you can re-run \nSpectacles in single-dimension mode, with `--mode single`.\n\n"
-                "You can also run this original validation with `--mode hybrid` to do this automatically."
+                printer.dim(
+                    "\n\nTo determine the exact dimensions responsible for "
+                    f"{'this error' if len(errors) == 1 else 'these errors'}, "
+                    "you can re-run \nSpectacles in single-dimension mode, "
+                    "with `--mode single`.\n\nYou can also run this original "
+                    "validation with `--mode hybrid` to do this automatically."
+                )
             )
 
         logger.info("")

spectacles/client.py

@@ -323,7 +323,7 @@ def get_active_branch(self, project: str) -> JsonDict:
                 status=response.status_code,
                 detail=(
                     f"Unable to get active branch for project '{project}'. "
-                    "Please try again."
+                    "Please check that the project exists and try again."
                 ),
                 response=response,
             )
@@ -718,3 +718,41 @@ def cancel_query_task(self, query_task_id: str):
 
         # No raise_for_status() here because Looker API seems to give a 404
         # if you try to cancel a finished query which can happen as part of cleanup
+
+    def content_validation(self) -> JsonDict:
+        logger.debug(f"Validating all content in Looker")
+        url = utils.compose_url(self.api_url, path=["content_validation"])
+        response = self.get(url=url, timeout=TIMEOUT_SEC)
+
+        try:
+            response.raise_for_status()
+        except requests.exceptions.HTTPError:
+            raise LookerApiError(
+                name="unable-to-validate-content",
+                title="Couldn't validate Looks and Dashboards.",
+                status=response.status_code,
+                detail=("Failed to run the content validator. Please try again."),
+                response=response,
+            )
+
+        result = response.json()
+        return result
+
+    def all_folders(self, project: str) -> List[JsonDict]:
+        logger.debug("Getting information about all folders")
+        url = utils.compose_url(self.api_url, path=["folders"])
+        response = self.get(url=url, timeout=TIMEOUT_SEC)
+
+        try:
+            response.raise_for_status()
+        except requests.exceptions.HTTPError:
+            raise LookerApiError(
+                name="unable-to-get-folders",
+                title="Couldn't obtain project folders.",
+                status=response.status_code,
+                detail=(f"Failed to get all folders for project '{project}'."),
+                response=response,
+            )
+
+        result = response.json()
+        return result

spectacles/exceptions.py

@@ -121,3 +121,27 @@ def __init__(
         super().__init__(
             model=model, explore=explore, test=None, message=message, metadata=metadata
         )
+
+
+class ContentError(ValidationError):
+    def __init__(
+        self,
+        model: str,
+        explore: str,
+        message: str,
+        field_name: str,
+        content_type: str,
+        title: str,
+        space: str,
+        url: str,
+    ):
+        metadata = {
+            "field_name": field_name,
+            "content_type": content_type,
+            "title": title,
+            "space": space,
+            "url": url,
+        }
+        super().__init__(
+            model=model, explore=explore, test=None, message=message, metadata=metadata
+        )