[DOCS] Quickstart code under test (#7542)

ci/azure-pipelines-dev.yml

@@ -224,8 +224,33 @@ stages:
              python -c "import great_expectations as gx; print('Successfully imported GX Version:', gx.__version__)"
            displayName: 'Import Great Expectations'
 
+  - stage: quickstart
+    dependsOn: scope_check
+    pool:
+      vmImage: 'ubuntu-20.04'
+
+    jobs:
+      - job: quickstart
+
+        steps:
+          - task: UsePythonVersion@0
+            inputs:
+              versionSpec: '3.7'
+            displayName: 'Use Python 3.7'
+
+          - script: |
+              pip install --constraint constraints-dev.txt ".[test]"
+              pip uninstall -y sqlalchemy
+            displayName: 'Install GX and required dependencies (i.e. not sqlalchemy)'
+
+          - script: |
+              pytest -v --no-sqlalchemy --docs-tests -m integration -k "test_docs[quickstart]" tests/integration/test_script_runner.py
+            displayName: 'Run Quickstart'
+
+
+
   - stage: required
-    dependsOn: [scope_check, lint, import_ge, custom_checks, unit_tests]
+    dependsOn: [scope_check, lint, import_ge, custom_checks, unit_tests, quickstart]
     pool:
       vmImage: 'ubuntu-20.04'
 

docs/sphinx_api_docs_source/public_api_report.py

@@ -1859,7 +1859,7 @@ def main():
     # any methods or classes you are adding to documentation with the @public_api
     # decorator and any relevant "new" or "deprecated" public api decorators.
     # If the actual is lower than the threshold, please reduce the threshold.
-    PUBLIC_API_MISSING_THRESHOLD = 96  # TODO: reduce this number again once this works for the Fluent DS dynamic methods
+    PUBLIC_API_MISSING_THRESHOLD = 97  # TODO: reduce this number again once this works for the Fluent DS dynamic methods
     if len(printable_definitions) != PUBLIC_API_MISSING_THRESHOLD:
         error_msg_prefix = f"There are {len(printable_definitions)} items missing from the public API, we currently allow {PUBLIC_API_MISSING_THRESHOLD}."
         if len(printable_definitions) > PUBLIC_API_MISSING_THRESHOLD:

tests/integration/docusaurus/tutorials/quickstart/quickstart.py

@@ -0,0 +1,28 @@
+import great_expectations as gx
+
+# Set up
+context = gx.get_context()
+
+# Connect to data
+validator = context.sources.pandas_default.read_csv(
+    "https://raw.githubusercontent.com/great-expectations/gx_tutorials/main/data/yellow_tripdata_sample_2019-01.csv"
+)
+
+# Create Expectations
+validator.expect_column_values_to_not_be_null("pickup_datetime")
+validator.expect_column_values_to_be_between("passenger_count", auto=True)
+
+# Validate data
+checkpoint = gx.checkpoint.SimpleCheckpoint(
+    name="my_quickstart_checkpoint",
+    data_context=context,
+    validator=validator,
+)
+checkpoint_result = checkpoint.run()
+
+# View results
+validation_result_identifier = checkpoint_result.list_validation_result_identifiers()[0]
+context.open_data_docs(resource_identifier=validation_result_identifier)
+
+# Save the Data Context for future use
+context.convert_to_file_context()

tests/integration/test_script_runner.py

@@ -1,7 +1,7 @@
 """Run integration and docs tests.
 
 Individual tests can be run by setting the '-k' flag and referencing the name of test, like the following example:
-    pytest -v --docs-tests -m integration -k "test_docs[migration_guide_spark_v2_api]" tests/integration/test_script_runner.py
+    pytest -v --docs-tests -m integration -k "test_docs[quickstart]" tests/integration/test_script_runner.py
 """
 
 import importlib.machinery
@@ -240,9 +240,17 @@
     ),
 ]
 
+quickstart = [
+    IntegrationTestFixture(
+        name="quickstart",
+        user_flow_script="tests/integration/docusaurus/tutorials/quickstart/quickstart.py",
+    ),
+]
+
 
 # populate docs_test_matrix with sub-lists
 docs_test_matrix += local_tests
+docs_test_matrix += quickstart
 docs_test_matrix += spark_integration_tests
 docs_test_matrix += sqlite_integration_tests
 docs_test_matrix += mysql_integration_tests