feat(ci): add pytest hooks for updating golden files (datahub-project#12581)

Author: hsheth2

Diff for: .github/workflows/metadata-ingestion.yml

@@ -27,7 +27,7 @@ concurrency:
 jobs:
   metadata-ingestion:
     runs-on: ubuntu-latest
-    timeout-minutes: 40
+    timeout-minutes: 60
     env:
       DATAHUB_TELEMETRY_ENABLED: false
       # TODO: Enable this once the test is fixed.

Diff for: metadata-ingestion-modules/airflow-plugin/tests/conftest.py

@@ -1,15 +1,14 @@
 import pathlib
 import site
 
+from datahub.testing.pytest_hooks import (  # noqa: F401,E402
+    load_golden_flags,
+    pytest_addoption,
+)
 
-def pytest_addoption(parser):
-    parser.addoption(
-        "--update-golden-files",
-        action="store_true",
-        default=False,
-    )
-
-
+# The integration tests run Airflow, with our plugin, in a subprocess.
+# To get more accurate coverage, we need to ensure that the coverage
+# library is available in the subprocess.
 # See https://coverage.readthedocs.io/en/latest/subprocess.html#configuring-python-for-sub-process-measurement
 coverage_startup_code = "import coverage; coverage.process_startup()"
 site_packages_dir = pathlib.Path(site.getsitepackages()[0])

Diff for: metadata-ingestion-modules/airflow-plugin/tests/integration/test_plugin.py

@@ -26,7 +26,6 @@
     HAS_AIRFLOW_LISTENER_API,
     HAS_AIRFLOW_STANDALONE_CMD,
 )
-from tests.utils import PytestConfig
 
 pytestmark = pytest.mark.integration
 
@@ -346,18 +345,13 @@ def _run_airflow(
 
 
 def check_golden_file(
-    pytestconfig: PytestConfig,
     output_path: pathlib.Path,
     golden_path: pathlib.Path,
     ignore_paths: Sequence[str] = (),
 ) -> None:
-    update_golden = pytestconfig.getoption("--update-golden-files")
-
     assert_metadata_files_equal(
         output_path=output_path,
         golden_path=golden_path,
-        update_golden=update_golden,
-        copy_output=False,
         ignore_paths=ignore_paths,
         ignore_order=True,
     )
@@ -434,7 +428,6 @@ class DagTestCase:
     ],
 )
 def test_airflow_plugin(
-    pytestconfig: PytestConfig,
     tmp_path: pathlib.Path,
     golden_filename: str,
     test_case: DagTestCase,
@@ -497,7 +490,6 @@ def test_airflow_plugin(
         _sanitize_output_file(airflow_instance.metadata_file)
 
         check_golden_file(
-            pytestconfig=pytestconfig,
             output_path=airflow_instance.metadata_file,
             golden_path=golden_path,
             ignore_paths=[
@@ -512,7 +504,6 @@ def test_airflow_plugin(
         if test_case.multiple_connections:
             _sanitize_output_file(airflow_instance.metadata_file2)
             check_golden_file(
-                pytestconfig=pytestconfig,
                 output_path=airflow_instance.metadata_file2,
                 golden_path=golden_path,
                 ignore_paths=[

Diff for: metadata-ingestion-modules/dagster-plugin/build.gradle

@@ -59,8 +59,8 @@ task lint(type: Exec, dependsOn: installDev) {
     "mypy --show-traceback --show-error-codes src/ tests/ examples/"
 }
 task lintFix(type: Exec, dependsOn: installDev) {
-  commandLine 'bash', '-x', '-c',
-    "source ${venv_name}/bin/activate && " +
+  commandLine 'bash', '-c',
+    "source ${venv_name}/bin/activate && set -x && " +
     "ruff check --fix src/ tests/ examples/ && " +
     "ruff format src/ tests/ examples/ "
 }
@@ -71,9 +71,9 @@ task installDevTest(type: Exec, dependsOn: [installDev]) {
   outputs.dir("${venv_name}")
   outputs.file(sentinel_file)
   commandLine 'bash', '-c',
-      "source ${venv_name}/bin/activate && set -x && " +
-      "${pip_install_command} -e .[dev,integration-tests] ${extra_pip_requirements} && " +
-      "touch ${sentinel_file}"
+    "source ${venv_name}/bin/activate && set -x && " +
+    "${pip_install_command} -e .[dev,integration-tests] ${extra_pip_requirements} && " +
+    "touch ${sentinel_file}"
 }
 
 task testQuick(type: Exec, dependsOn: installDevTest) {

Diff for: metadata-ingestion-modules/dagster-plugin/tests/conftest.py

@@ -0,0 +1,4 @@
+from datahub.testing.pytest_hooks import (  # noqa: F401,E402
+    load_golden_flags,
+    pytest_addoption,
+)