Stop hardcoding relative paths to pyproject.toml (#29108)

We set a root pyproject.toml with some pytest settings in it. And then,
by convention, we call `pytest -c {relative_path}/pyproject.toml`

But we do that really inconsistently. Some have their own pyproject.toml
that we accidentally point at (either by messing up a relative path or
via auto discovery). None of these other pyproject.toml files have their
own pytest configuration so we're just pre-empting our global one.

This switches us to setting a `PYTEST_ADDOPTS` env var that we pass
through in buildkite to all build steps. And adds lints to make sure
we're not accidentally subverting it.

Author: jmsanders

Diff for: .buildkite/dagster-buildkite/dagster_buildkite/step_builder.py

@@ -85,6 +85,7 @@ def on_python_image(
             if env.startswith("BUILDKITE") or env.startswith("CI_")
         ]
         buildkite_envvars.append("BUILDKITE_ANALYTICS_TOKEN")
+        buildkite_envvars.append("PYTEST_ADDOPTS")
 
         # Set PYTEST_DEBUG_TEMPROOT to our mounted /tmp volume. Any time the
         # pytest `tmp_path` or `tmpdir` fixtures are used used, the temporary

Diff for: .buildkite/dagster-buildkite/lints.py

@@ -19,18 +19,20 @@ def find_tox_ini():
 def tox_config(request):
     config = configparser.ConfigParser()
     config.read(request.param)
+
+    assert "testenv" in config
+    assert "passenv" in config["testenv"]
+
     return config
 
 
 def test_tox_passenv(tox_config):
     PASSENV_ENV = [
         "BUILDKITE*",
+        "PYTEST_ADDOPTS",
         "PYTEST_PLUGINS",
     ]
 
-    assert "testenv" in tox_config
-    assert "passenv" in tox_config["testenv"]
-
     missing_env = []
     for env in PASSENV_ENV:
         if env not in tox_config["testenv"]["passenv"].split("\n"):
@@ -47,3 +49,10 @@ def test_no_subdirectory_pytest_ini():
             pytest_ini_files.append(pytest_ini_file)
 
     assert not pytest_ini_files, f"Subdirectory pytest.ini files conflict with our root pyproject.toml settings and conftest.py discovery. Please remove: {pytest_ini_files}"
+
+
+def test_no_tox_pytest_config_override(tox_config):
+    if "commands" in tox_config["testenv"]:
+        assert (
+            "pyproject.toml" not in tox_config["testenv"]["commands"]
+        ), "We use a global PYTEST_CONFIG that uses the root directory's pyproject.toml. Remove any -c overrides in pytest commands in tox.ini"

Diff for: .buildkite/hooks/pre-command

@@ -3,3 +3,4 @@ set -eu
 . ./.buildkite/scripts/docker_prune.sh
 
 export BUILDKITE_ANALYTICS_TOKEN=$DAGSTER_BUILDKITE_TEST_ANALYTICS_TOKEN
+export PYTEST_ADDOPTS="-c /workdir/pyproject.toml"

Diff for: docs/sphinx/_ext/dagster-sphinx/tox.ini

@@ -6,9 +6,10 @@ download = True
 passenv =
     CI_PULL_REQUEST
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 allowlist_externals =
   /bin/bash
 commands =
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv {posargs}
+  pytest -vv {posargs}

Diff for: docs/sphinx/_ext/sphinx-click/tox.ini

@@ -5,6 +5,7 @@ envlist = py{38,39,310,311,312}-click{8,8-async},style,docs
 [testenv]
 passenv =
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 setenv =
     PYTHONDEVMODE = 1

Diff for: docs/sphinx/_ext/sphinx-mdx-builder/tox.ini

@@ -10,6 +10,7 @@ envlist =
 [testenv]
 passenv =
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 
 basepython =

Diff for: docs/tox.ini

@@ -10,6 +10,7 @@ passenv =
     AWS_ACCESS_KEY_ID
     BUILDKITE*
     LC_ALL
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 allowlist_externals =
   make

Diff for: examples/airlift-federation-tutorial/tox.ini

@@ -6,6 +6,7 @@ download = True
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -27,4 +28,4 @@ commands =
   # We need to rebuild the UI to ensure that the dagster-webserver can run
   make -C ../.. rebuild_ui
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ./pyproject.toml ./airlift_federation_tutorial_tests --snapshot-warn-unused -vv {posargs}
+  pytest ./airlift_federation_tutorial_tests --snapshot-warn-unused -vv {posargs}

Diff for: examples/airlift-migration-tutorial/tox.ini

@@ -6,6 +6,7 @@ download = True
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -27,4 +28,4 @@ commands =
   # We need to rebuild the UI to ensure that the dagster-webserver can run
   make -C ../.. rebuild_ui
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml ./tutorial_example_tests --snapshot-warn-unused -vv {posargs}
+  pytest ./tutorial_example_tests --snapshot-warn-unused -vv {posargs}

Diff for: examples/assets_dbt_python/tox.ini

@@ -6,6 +6,7 @@ download = true
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 ; note: "source" does not work at this time due to dagster-cloud source access
@@ -26,4 +27,4 @@ allowlist_externals =
   uv
 commands =
   source: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/assets_dynamic_partitions/tox.ini

@@ -6,6 +6,7 @@ download = true
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -20,4 +21,4 @@ allowlist_externals =
   uv
 commands =
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/assets_modern_data_stack/tox.ini

@@ -6,6 +6,7 @@ download = True
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 ; note: "source" does not work at this time due to dagster-cloud source access
@@ -27,4 +28,4 @@ allowlist_externals =
   uv
 commands =
   source: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/assets_pandas_pyspark/tox.ini

@@ -6,6 +6,7 @@ download = true
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install -b ../../python_modules/libraries/dagster-pyspark/build-constraints {opts} {packages}
 deps =
@@ -22,4 +23,4 @@ allowlist_externals =
   uv
 commands =
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/assets_pandas_type_metadata/tox.ini

@@ -6,6 +6,7 @@ download = True
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -21,4 +22,4 @@ allowlist_externals =
   uv
 commands =
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/assets_smoke_test/tox.ini

@@ -6,6 +6,7 @@ download = true
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =

Diff for: examples/deploy_docker/tox.ini

@@ -7,6 +7,7 @@ passenv =
     CI_*
     BUILDKITE*
     DEPLOY_DOCKER_WEBSERVER_HOST
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -18,4 +19,4 @@ allowlist_externals =
   uv
 commands =
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv {posargs}
+  pytest -vv {posargs}

Diff for: examples/deploy_ecs/tox.ini

@@ -7,6 +7,7 @@ passenv =
     CI_*
     BUILDKITE*
     DEPLOY_DOCKER_WEBSERVER_HOST
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =

Diff for: examples/development_to_production/tox.ini

@@ -6,6 +6,7 @@ download = True
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -22,4 +23,4 @@ allowlist_externals =
   uv
 commands =
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv {posargs}
+  pytest -vv {posargs}

Diff for: examples/docs_snippets/tox.ini

@@ -9,6 +9,7 @@ passenv =
     BUILDKITE*
     EXTRA_PARAMS
     DAGSTER_CLI_SNIPPET_WORKING_DIR
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 ; dagstermill test errors prevent using uv, require compat mode install
 ; install_command = uv pip install {opts} {packages}
@@ -90,15 +91,15 @@ commands =
   all: uv pip install dagster-cloud --no-deps
   all: uv pip install path
   all: /bin/bash -c '! pip list --exclude-editable | grep -e dagster | grep -v dagster-cloud'
-  all: pytest -c ../../pyproject.toml -vv {posargs} --ignore=docs_snippets_tests/test_integration_files_load.py --ignore=docs_snippets_tests/snippet_checks
+  all: pytest -vv {posargs} --ignore=docs_snippets_tests/test_integration_files_load.py --ignore=docs_snippets_tests/snippet_checks
 
   integrations: uv pip install dagster-cloud-cli --no-deps
   integrations: uv pip install dagster-cloud --no-deps
   integrations: uv pip install path
   integrations: /bin/bash -c '! pip list --exclude-editable | grep -e dagster | grep -v dagster-cloud'
-  integrations: pytest -c ../../pyproject.toml -vv {posargs} docs_snippets_tests/test_integration_files_load.py
+  integrations: pytest -vv {posargs} docs_snippets_tests/test_integration_files_load.py
 
   docs_snapshot_test: sh ./docs_snippets_tests/ensure_snapshot_deps.sh
-  docs_snapshot_test: pytest -c ../../pyproject.toml -vv {posargs} docs_snippets_tests/snippet_checks
+  docs_snapshot_test: pytest -vv {posargs} docs_snippets_tests/snippet_checks
   docs_snapshot_update: sh ./docs_snippets_tests/ensure_snapshot_deps.sh
-  docs_snapshot_update: pytest -c ../../pyproject.toml -vv {posargs} docs_snippets_tests/snippet_checks --update-snippets {env:EXTRA_PARAMS}
+  docs_snapshot_update: pytest -vv {posargs} docs_snippets_tests/snippet_checks --update-snippets {env:EXTRA_PARAMS}

Diff for: examples/experimental/assets_yaml_dsl/tox.ini

@@ -6,6 +6,7 @@ download = True
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -20,4 +21,4 @@ allowlist_externals =
   uv
 commands =
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/experimental/dagster-dlift/kitchen-sink/tox.ini

@@ -7,6 +7,7 @@ passenv =
     CI_*
     BUILDKITE*
     KS_DBT_CLOUD*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -28,4 +29,4 @@ commands =
   # We need to rebuild the UI to ensure that the dagster-webserver can run
   make -C ../../../.. rebuild_ui
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../../pyproject.toml ./dlift_kitchen_sink_tests --snapshot-warn-unused -vv {posargs}
+  pytest ./dlift_kitchen_sink_tests --snapshot-warn-unused -vv {posargs}

Diff for: examples/experimental/dagster-dlift/tox.ini

@@ -6,6 +6,7 @@ download = True
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -24,4 +25,4 @@ commands =
   # We need to rebuild the UI to ensure that the dagster-webserver can run
   make -C ../../.. rebuild_ui
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../../pyproject.toml ./dagster_dlift_tests --snapshot-warn-unused -vv {posargs}
+  pytest ./dagster_dlift_tests --snapshot-warn-unused -vv {posargs}

Diff for: examples/feature_graph_backed_assets/tox.ini

@@ -6,6 +6,7 @@ download = True
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -20,4 +21,4 @@ allowlist_externals =
   uv
 commands =
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/project_fully_featured/tox.ini

@@ -10,6 +10,7 @@ passenv =
     SNOWFLAKE_ACCOUNT
     SNOWFLAKE_USER
     SNOWFLAKE_PASSWORD
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install -b ../../python_modules/libraries/dagster-pyspark/build-constraints {opts} {packages}
 deps =
@@ -31,4 +32,4 @@ allowlist_externals =
   uv
 commands =
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/quickstart_aws/tox.ini

@@ -6,6 +6,7 @@ download = true
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 ; version resolution issues prevent using uv
 ; install_command = uv pip install {opts} {packages}
@@ -24,4 +25,4 @@ allowlist_externals =
   uv
 commands =
   source: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/quickstart_etl/tox.ini

@@ -6,6 +6,7 @@ download = true
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 ; note: "source" does not work at this time due to dagster-cloud source access
@@ -21,4 +22,4 @@ allowlist_externals =
   uv
 commands =
   source: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/quickstart_gcp/tox.ini

@@ -6,6 +6,7 @@ download = true
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 ; note: "source" does not work at this time due to dagster-cloud source access
@@ -24,4 +25,4 @@ allowlist_externals =
   uv
 commands =
   source: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/quickstart_snowflake/tox.ini

@@ -6,6 +6,7 @@ download = true
 passenv =
     CI_*
     BUILDKITE*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 ; note: "source" does not work at this time due to dagster-cloud source access
@@ -25,4 +26,4 @@ allowlist_externals =
   uv
 commands =
   source: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ../../pyproject.toml -vv
+  pytest -vv

Diff for: examples/starlift-demo/tox.ini

@@ -7,6 +7,7 @@ passenv =
     CI_*
     BUILDKITE*
     KS_DBT_CLOUD*
+    PYTEST_ADDOPTS
     PYTEST_PLUGINS
 install_command = uv pip install {opts} {packages}
 deps =
@@ -29,4 +30,4 @@ commands =
   # We need to rebuild the UI to ensure that the dagster-webserver can run
   make -C ../.. rebuild_ui
   !windows: /bin/bash -c '! pip list --exclude-editable | grep -e dagster'
-  pytest -c ./pyproject.toml ./dbt_example_tests --snapshot-warn-unused -vv -s {posargs}
+  pytest ./dbt_example_tests --snapshot-warn-unused -vv -s {posargs}