Skip to content

feat: #1708 - [DOC] Update documentation for running tests with local services - #1710

Closed
ravencore06 wants to merge 2 commits into
openml:mainfrom
ravencore06:doc/local-services-testing
Closed

ravencore06 wants to merge 2 commits into
openml:mainfrom
ravencore06:doc/local-services-testing

Conversation

@ravencore06

Copy link
Copy Markdown

Summary of Changes:

  1. openml/config.py - Added local services support:

    • New constant OPENML_USE_LOCAL_SERVICES_ENV_VAR = "OPENML_USE_LOCAL_SERVICES"
    • New constant LOCAL_SERVER_URL = "http://localhost:8080"
    • New function use_local_services() to check if local services should be used
  2. tests/conftest.py- Updated test fixture:

    • Modified with_server fixture to check use_local_services() and use local server URL when enabled
  3. docs/developer_setup.md - Added documentation:

    • New section "Running Tests with Local Services" with:
      • Prerequisites (start local Docker services)
      • Environment variable setup for Windows/Linux
      • Example pytest commands

Why this change:
The CI recently switched to running tests against local services using Docker instead of the remote test server (PRs #1629, #1697). Contributors need documentation on how to run tests against these local services for development.

- Make OpenMLSetup inherit from OpenMLBase to enable tagging
- Add OpenMLSetup to _get_rest_api_type_alias mapping
- Add test_tagging test for push_tag and remove_tag
@PGijsbers

Copy link
Copy Markdown
Collaborator

Thanks for taking the time to contribute. While adding the documentation on how to run the local services is welcome, this PR also includes a number of unrelated changes. We will continue in the (later) duplicate PR #1717 for that reason.

@PGijsbers PGijsbers closed this Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants