{"id":28496035,"url":"https://github.com/sonarsource/orchestrator","last_synced_at":"2026-01-06T15:16:07.203Z","repository":{"id":2039270,"uuid":"42050815","full_name":"SonarSource/orchestrator","owner":"SonarSource","description":"Java library for running SonarQube in tests","archived":false,"fork":false,"pushed_at":"2025-05-16T14:39:34.000Z","size":48462,"stargazers_count":17,"open_issues_count":0,"forks_count":7,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-06-08T11:51:23.906Z","etag":null,"topics":["sonarqube"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SonarSource.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-09-07T12:05:53.000Z","updated_at":"2025-05-16T14:39:38.000Z","dependencies_parsed_at":"2023-07-08T07:49:19.975Z","dependency_job_id":"ad804fed-47e8-45c8-9529-d93bced4026d","html_url":"https://github.com/SonarSource/orchestrator","commit_stats":null,"previous_names":[],"tags_count":68,"template":false,"template_full_name":null,"purl":"pkg:github/SonarSource/orchestrator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SonarSource%2Forchestrator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SonarSource%2Forchestrator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SonarSource%2Forchestrator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SonarSource%2Forchestrator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SonarSource","download_url":"https://codeload.github.com/SonarSource/orchestrator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SonarSource%2Forchestrator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263120574,"owners_count":23416844,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["sonarqube"],"created_at":"2025-06-08T11:38:29.212Z","updated_at":"2026-01-06T15:16:07.197Z","avatar_url":"https://github.com/SonarSource.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://github.com/SonarSource/orchestrator/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/SonarSource/orchestrator/actions/workflows/build.yml?query=branch%3Amaster)\nOrchestrator is a Java library to install and run SonarQube from tests.\n\n## JUnit 4 API\n\nAn instance of class `com.sonar.orchestrator.junit4.OrchestratorRule` can be used as `Rule` or `ClassRule`. It will represent a SonarQube server that will be started before tests, and stopped after:\n\n```\npublic class MyTest {\n\n    @ClassRule\n    public static OrchestratorRule ORCHESTRATOR = OrchestratorRule.builderEnv()\n      .setSonarVersion(\"7.0\")\n      .addPlugin(FileLocation.of(\"/path/to/plugin.jar\"))\n      .addPlugin(MavenLocation.of(\"org.sonarsource.java\", \"sonar-java-plugin\", \"5.2.0.13398\")\n      .setServerProperty(\"sonar.web.javaOpts\", \"-Xmx1G\")\n      .build();\n\n    @Test\n    public void myTest() {\n        // run SonarQube Scanner\n        ORCHESTRATOR.executeBuild(SonarScanner.create(new File(\"/path/to/project\")));\n\n        // requests web services\n        String baseUrl = ORCHESTRATOR.getServer().getUrl();\n        // ...\n    }\n\n}\n```\n\n## JUnit 5 API\n\nAn instance of class `com.sonar.orchestrator.junit5.OrchestratorExtension` can be used as `Extension`. It will represent a SonarQube server that will be started before tests, and stopped after:\n\n```\nclass MyTests {\n\n    @RegisterExtension\n    static OrchestratorExtension ORCHESTRATOR = OrchestratorExtension.builderEnv()\n      .setSonarVersion(\"7.0\")\n      .addPlugin(FileLocation.of(\"/path/to/plugin.jar\"))\n      .addPlugin(MavenLocation.of(\"org.sonarsource.java\", \"sonar-java-plugin\", \"5.2.0.13398\")\n      .setServerProperty(\"sonar.web.javaOpts\", \"-Xmx1G\")\n      .build();\n\n    @Test\n    void myTest() {\n        // run SonarQube Scanner\n        ORCHESTRATOR.executeBuild(SonarScanner.create(new File(\"/path/to/project\")));\n\n        // requests web services\n        String baseUrl = ORCHESTRATOR.getServer().getUrl();\n        // ...\n    }\n\n}\n```\n\n## Version Aliases\n\nAliases can be used to define the versions of SonarQube and plugins to be installed. Supported values are:\n\n- `DEV` for the latest official build (in terms of version number, not date)\n- `DEV[x.y]` for the latest official build of a series. For example `DEV[5.2]` may install version `5.2.0.1234`.\n- `LATEST_RELEASE` for the latest release (in terms of version number, not date)\n- `LATEST_RELEASE[x.y]` for the latest release of a series, for example `LATEST_RELEASE[5.2]`\n\nThe alias `LTS` is no more supported for SonarQube since Orchestrator 3.17. It should be replaced by `LATEST_RELEASE[6.7]`.\n\nPlease note that since Orchestrator 4.7, if the default value of `orchestrator.artifactory.url` (https://repox.jfrog.io/repox) is _not_ used, \nthe `DEV` alias will not work.\n\n## Local Cache\n\nThe artifacts downloaded from Artifactory (SonarQube, plugins) are copied to the local directory `~/.sonar/orchestrator/cache`.\nThis directory is _not_ automatically purged and may grow significantly when using the version alias\n`DEV`.\n\n## Configuration\n\nThe test environment is configured in the file `~/.sonar/orchestrator/orchestrator.properties`:\n\n    # Token used to download SonarSource private artifacts from https://repox.jfrog.io/repox\n    # Generate your identity token at https://repox.jfrog.io/ui/user_profile\n    # This property can be replaced by the environment variable ARTIFACTORY_ACCESS_TOKEN.\n    #orchestrator.artifactory.accessToken=xxx\n\n    # Fine-grained Personal access token used to request SonarSource development licenses at https://github.com/sonarsource/licenses.\n    # Generate a token from https://github.com/settings/personal-access-tokens/new\n    # The token needs `SonarSource` as the Resource Owner and Read-only access for the SonarSource/licenses repository.\n    # This property can be replaced by the environment variable GITHUB_TOKEN.\n    #github.token=xxx\n\n    # Port of SonarQube server. Default value is 0 (random).\n    #orchestrator.container.port=10000\n\n    # Maven installation, used when running Scanner for Maven.\n    # By default Maven binary is searched in $PATH\n    #maven.home=/usr/local/Cellar/maven/3.5.0/libexec\n\n    # Maven local repository (optional), used to search artifacts of plugins before\n    # downloading from Artifactory.\n    # Default is ~/.m2/repository\n    #maven.localRepository=/path/to/maven/repository\n\n    # Instance of Artifactory. Default is SonarSource's instance (https://repox.jfrog.io/repox).\n    # This property can be replaced by the environment variable ARTIFACTORY_URL.\n    # To use maven central instead, use https://repo1.maven.org/maven2\n    # To use a custom instance, use your own URL that points to a Maven repository.\n    #orchestrator.artifactory.url=https://repo1.maven.org/maven2\n\nThe path to configuration file can be overridden with the system property `orchestrator.configUrl`\nor the environment variable `ORCHESTRATOR_CONFIG_URL`.\nExample: `-Dorchestrator.configUrl=file:///path/to/orchestrator.properties`\n\n## HTTP Proxy\n\nFor running Orchestrator behind a corporate proxy, add Java properties :\n\n    -Dhttp.proxyHost=proxy.company.com\n    -Dhttp.proxyPort=80\n    -Dhttps.proxyHost=proxy.company.com\n    -Dhttps.proxyPort=80\n    -Dhttp.nonProxyHosts=\"localhost|127.0.0.1|*.company.com\"\n    -Dhttp.proxyUser=foo\n    -Dhttp.proxyPassword=bar\n\n## License\n\nCopyright 2011-2025 SonarSource Sàrl.\n\nLicensed under the [GNU Lesser General Public License, Version 3.0](http://www.gnu.org/licenses/lgpl.txt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsonarsource%2Forchestrator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsonarsource%2Forchestrator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsonarsource%2Forchestrator/lists"}