├── .github └── workflows │ └── nebula.yml ├── .gitignore ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── build.gradle ├── dependencies.lock ├── gradle.properties.enc ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src ├── main └── groovy │ └── nebula │ └── plugin │ └── override │ ├── DotNotationWalkerOverrideStrategy.groovy │ ├── NebulaOverridePlugin.groovy │ ├── OverrideStrategy.groovy │ ├── UnknownPropertyException.java │ ├── converter │ ├── ApacheCommonsTypeConverter.groovy │ └── TypeConverter.groovy │ └── reader │ ├── AggregateOverrideReader.groovy │ ├── EnvironmentVariableOverrideReader.groovy │ ├── OverrideReader.groovy │ └── SystemPropertyOverrideReader.groovy └── test └── groovy └── nebula └── plugin └── override ├── DotNotationWalkerOverrideStrategyTest.groovy ├── NebulaOverridePluginIntegrationTest.groovy ├── converter └── ApacheCommonsTypeConverterTest.groovy └── reader ├── AggregateOverrideReaderTest.groovy ├── EnvironmentVariableOverrideReaderTest.groovy └── SystemPropertyOverrideReaderTest.groovy /.github/workflows/nebula.yml: -------------------------------------------------------------------------------- 1 | name: Nebula Build 2 | on: 3 | push: 4 | branches: 5 | - '*' 6 | tags: 7 | - v*.*.* 8 | - v*.*.*-rc.* 9 | pull_request: 10 | 11 | jobs: 12 | validation: 13 | name: "Gradle Wrapper Validation" 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: actions/checkout@v2 17 | - uses: gradle/wrapper-validation-action@v1 18 | buildmultijdk: 19 | if: (!startsWith(github.ref, 'refs/tags/v')) 20 | needs: validation 21 | runs-on: ubuntu-latest 22 | strategy: 23 | matrix: 24 | # test against latest update of some major Java version(s), as well as specific LTS version(s) 25 | java: [ 8, 17, 21] 26 | name: Gradle Build without Publish 27 | steps: 28 | - uses: actions/checkout@v1 29 | - name: Set up JDK 8 30 | uses: actions/setup-java@v2 31 | with: 32 | distribution: 'zulu' 33 | java-version: '8' 34 | java-package: jdk 35 | - name: Setup jdk 36 | uses: actions/setup-java@v2 37 | with: 38 | distribution: 'zulu' 39 | java-version: ${{ matrix.java }} 40 | java-package: jdk 41 | - uses: actions/cache@v1 42 | id: gradle-cache 43 | with: 44 | path: ~/.gradle/caches 45 | key: ${{ runner.os }}-gradle-${{ hashFiles('**/gradle/dependency-locks/*.lockfile') }} 46 | restore-keys: | 47 | - ${{ runner.os }}-gradle- 48 | - uses: actions/cache@v1 49 | id: gradle-wrapper-cache 50 | with: 51 | path: ~/.gradle/wrapper 52 | key: ${{ runner.os }}-gradlewrapper-${{ hashFiles('gradle/wrapper/*') }} 53 | restore-keys: | 54 | - ${{ runner.os }}-gradlewrapper- 55 | - name: Gradle build 56 | run: ./gradlew --info --stacktrace build 57 | env: 58 | JDK_VERSION_FOR_TESTS: ${{ matrix.java }} 59 | validatepluginpublication: 60 | if: startsWith(github.ref, 'refs/tags/v') 61 | needs: validation 62 | runs-on: ubuntu-latest 63 | name: Gradle Plugin Publication Validation 64 | env: 65 | NETFLIX_OSS_SONATYPE_USERNAME: ${{ secrets.ORG_SONATYPE_USERNAME }} 66 | NETFLIX_OSS_SONATYPE_PASSWORD: ${{ secrets.ORG_SONATYPE_PASSWORD }} 67 | steps: 68 | - uses: actions/checkout@v1 69 | - name: Setup jdk 8 70 | uses: actions/setup-java@v1 71 | with: 72 | java-version: 1.8 73 | - uses: actions/cache@v1 74 | id: gradle-cache 75 | with: 76 | path: ~/.gradle/caches 77 | key: ${{ runner.os }}-gradle-${{ hashFiles('**/gradle/dependency-locks/*.lockfile') }} 78 | restore-keys: | 79 | - ${{ runner.os }}-gradle- 80 | - uses: actions/cache@v1 81 | id: gradle-wrapper-cache 82 | with: 83 | path: ~/.gradle/wrapper 84 | key: ${{ runner.os }}-gradlewrapper-${{ hashFiles('gradle/wrapper/*') }} 85 | restore-keys: | 86 | - ${{ runner.os }}-gradlewrapper- 87 | - name: Verify plugin publication 88 | if: | 89 | startsWith(github.ref, 'refs/tags/v') && 90 | (!contains(github.ref, '-rc.')) 91 | run: ./gradlew --stacktrace -Dgradle.publish.key=${{ secrets.gradlePublishKey }} -Dgradle.publish.secret=${{ secrets.gradlePublishSecret }} -Prelease.useLastTag=true final publishPlugin --validate-only -x check -x signPluginMavenPublication 92 | publish: 93 | if: startsWith(github.ref, 'refs/tags/v') 94 | needs: validatepluginpublication 95 | runs-on: ubuntu-latest 96 | name: Gradle Build and Publish 97 | env: 98 | NETFLIX_OSS_SONATYPE_USERNAME: ${{ secrets.ORG_SONATYPE_USERNAME }} 99 | NETFLIX_OSS_SONATYPE_PASSWORD: ${{ secrets.ORG_SONATYPE_PASSWORD }} 100 | NETFLIX_OSS_SIGNING_KEY: ${{ secrets.ORG_SIGNING_KEY }} 101 | NETFLIX_OSS_SIGNING_PASSWORD: ${{ secrets.ORG_SIGNING_PASSWORD }} 102 | NETFLIX_OSS_REPO_USERNAME: ${{ secrets.ORG_NETFLIXOSS_USERNAME }} 103 | NETFLIX_OSS_REPO_PASSWORD: ${{ secrets.ORG_NETFLIXOSS_PASSWORD }} 104 | steps: 105 | - uses: actions/checkout@v1 106 | - name: Setup jdk 8 107 | uses: actions/setup-java@v1 108 | with: 109 | java-version: 1.8 110 | - uses: actions/cache@v1 111 | id: gradle-cache 112 | with: 113 | path: ~/.gradle/caches 114 | key: ${{ runner.os }}-gradle-${{ hashFiles('**/gradle/dependency-locks/*.lockfile') }} 115 | restore-keys: | 116 | - ${{ runner.os }}-gradle- 117 | - uses: actions/cache@v1 118 | id: gradle-wrapper-cache 119 | with: 120 | path: ~/.gradle/wrapper 121 | key: ${{ runner.os }}-gradlewrapper-${{ hashFiles('gradle/wrapper/*') }} 122 | restore-keys: | 123 | - ${{ runner.os }}-gradlewrapper- 124 | - name: Publish candidate 125 | if: | 126 | startsWith(github.ref, 'refs/tags/v') && 127 | contains(github.ref, '-rc.') 128 | run: ./gradlew --info --stacktrace -Prelease.useLastTag=true candidate 129 | - name: Publish release 130 | if: | 131 | startsWith(github.ref, 'refs/tags/v') && 132 | (!contains(github.ref, '-rc.')) 133 | run: ./gradlew --info --stacktrace -Dgradle.publish.key=${{ secrets.gradlePublishKey }} -Dgradle.publish.secret=${{ secrets.gradlePublishSecret }} -Prelease.useLastTag=true final 134 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle/ 2 | build/ 3 | .idea/ 4 | *.ipr 5 | *.iml -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | 3.0.2 / 2015-11-16 2 | ================== 3 | 4 | * Republish to get on plugin portal 5 | 6 | 3.0.1 / 2015-10-21 7 | ================== 8 | 9 | * Move to gradle 2.8 10 | 11 | 3.0.0 / 2015-09-15 12 | ================== 13 | 14 | * Update to new build 15 | * Move to gradle 2.7 16 | 17 | 2.2.0 / 2015-01-30 18 | ================== 19 | 20 | * Move to gradle 2.2.1 21 | 22 | 2.0.1 / 2014-11-19 23 | ================== 24 | 25 | * Issue #1: Unable to override not initialized Boolean property with false value 26 | * Pull #9: Emit warning if property cannot be foubd. 27 | 28 | 2.0.0 / 2014-09-19 29 | ================== 30 | 31 | * Upgrade to Gradle 2.0 32 | 33 | 1.12.1 / 2014-10-01 34 | ================== 35 | 36 | * Issue #1: Unable to override not initialized Boolean property with false value 37 | 38 | 1.12.0 / 2014-07-10 39 | ================== 40 | 41 | * Initial release 42 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Nebula 2 | 3 | If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request. When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. 4 | 5 | ## License 6 | 7 | By contributing your code, you agree to license your contribution under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0). Your contributions should also include the following header: 8 | 9 | ``` 10 | /** 11 | * Copyright 2015 the original author or authors. 12 | * 13 | * Licensed under the Apache License, Version 2.0 (the "License"); 14 | * you may not use this file except in compliance with the License. 15 | * You may obtain a copy of the License at 16 | * 17 | * http://www.apache.org/licenses/LICENSE-2.0 18 | * 19 | * Unless required by applicable law or agreed to in writing, software 20 | * distributed under the License is distributed on an "AS IS" BASIS, 21 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 22 | * See the License for the specific language governing permissions and 23 | * limitations under the License. 24 | */ 25 | ``` 26 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | 204 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | gradle-override-plugin 2 | ============== 3 | ![Support Status](https://img.shields.io/badge/nebula-unsupported-red.svg) 4 | [![Gradle Plugin Portal](https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/com.netflix.nebula/gradle-override-plugin/maven-metadata.xml.svg?label=gradlePluginPortal)](https://plugins.gradle.org/plugin/com.netflix.nebula.override) 5 | [![Maven Central](https://img.shields.io/maven-central/v/com.netflix.nebula/gradle-override-plugin)](https://maven-badges.herokuapp.com/maven-central/com.netflix.nebula/gradle-override-plugin) 6 | ![Build](https://github.com/nebula-plugins/gradle-override-plugin/actions/workflows/nebula.yml/badge.svg) 7 | [![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-override-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0) 8 | 9 | ***This plugin is no longer supported.*** 10 | 11 | Plugin for overriding properties in a project from the command line. The main use case for this functionality is to avoid 12 | the introduction of "magic" system/project properties for providing user-driven property values as part of build logic. 13 | Property names are provided as String and are looked up by dot notation. If no matching property can be resolved, the build fails. 14 | 15 | ## The world without the plugin 16 | 17 | A typical scenario without the plugin looks as such: 18 | 19 | extensions.create('example', MyExtension) 20 | 21 | class MyExtension { 22 | String myProp 23 | Integer otherProp 24 | Boolean flag 25 | } 26 | 27 | example { 28 | myProp = System.getProperty('my.prop') ?: 'hello' 29 | otherProp = System.getProperty('other.prop') ? System.getProperty('other.prop').toInteger() : 1 30 | flag = System.getProperty('flag') ? System.getProperty('other.prop').toBoolean() : true 31 | } 32 | 33 | In this scenario, the build script user can override the default value assigned to the extension property `myProp` by 34 | providing the system property `my.prop` on the command line. This works. However, the build script author has to implement 35 | this functionality for every property that is supposed to be overriden from the command line. With an increasing amount of 36 | code this becomes very tedious. Furthermore, the build script user has to know the name of system property. 37 | 38 | ## Usage 39 | 40 | ### Applying the Plugin 41 | 42 | 43 | To apply this plugin if using Gradle 2.1 or newer 44 | 45 | plugins { 46 | id 'com.netflix.nebula.override' version '4.0.0' 47 | } 48 | 49 | If using an older version of Gradle 50 | 51 | buildscript { 52 | repositories { mavenCentral() } 53 | 54 | dependencies { 55 | classpath 'com.netflix.nebula:gradle-override-plugin:4.0.0' 56 | } 57 | } 58 | 59 | apply plugin: 'com.netflix.nebula.override' 60 | 61 | ### Overriding properties with the plugin 62 | 63 | Overriding properties is not limited to specific Gradle domain objects. You can override all writeable properties. Some 64 | examples: 65 | 66 | * Project properties e.g. `buildDir` 67 | * Task properties e.g. `javadoc.maxMemory` 68 | * Extension properties on any nested level 69 | 70 | You can override properties through the following methods: 71 | 72 | * By providing an environment variable with the prefix `OVERRIDE_`. 73 | * By providing a system property with the prefix `override.`. 74 | 75 | Override properties provided through system properties take precedence over the ones provided by environment variables. 76 | 77 | Let's consider the following, modified build script code: 78 | 79 | apply plugin: 'nebula.override' 80 | 81 | class MyExtension { 82 | String myProp 83 | } 84 | 85 | example { 86 | myProp = 'hello' 87 | } 88 | 89 | The plugin defers overriding existing properties until the project is parsed during the configuration phase to allow for 90 | changing values of all properties. Property values are automatically converted to the correct type. From the command line 91 | the build script user can override the default value `hello` of myProp by providing `-Doverride.example.myProp=newValue`. 92 | 93 | ### Future improvements 94 | 95 | * Introduce a plugin-specific argument that doesn't require a "prefix" similar to project properties e.g. 96 | `-Nexample.myProp=newValue`. This will require a change in Gradle core as the functionality to add new command line handlers 97 | (see `AbstractPropertiesCommandLineConverter`) is not exposed. 98 | 99 | Gradle Compatibility Tested 100 | --------------------------- 101 | 102 | Built with Oracle JDK7 103 | Tested with Oracle JDK8 104 | 105 | | Gradle Version | Works | 106 | | :------------: | :---: | 107 | | 2.2.1 | yes | 108 | | 2.3 | yes | 109 | | 2.4 | yes | 110 | | 2.5 | yes | 111 | | 2.6 | yes | 112 | | 2.7 | yes | 113 | | 2.8 | yes | 114 | 115 | LICENSE 116 | ======= 117 | 118 | Copyright 2014-2015 Netflix, Inc. 119 | 120 | Licensed under the Apache License, Version 2.0 (the "License"); 121 | you may not use this file except in compliance with the License. 122 | You may obtain a copy of the License at 123 | 124 | 125 | 126 | Unless required by applicable law or agreed to in writing, software 127 | distributed under the License is distributed on an "AS IS" BASIS, 128 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 129 | See the License for the specific language governing permissions and 130 | limitations under the License. 131 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2014-2018 Netflix, Inc. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | 18 | plugins { 19 | id 'com.netflix.nebula.plugin-plugin' version '20.8.0' 20 | } 21 | 22 | description 'Override arbitrary properties in a Gradle build' 23 | 24 | contacts { 25 | 'nebula-plugins-oss@netflix.com' { 26 | moniker 'Nebula Plugins Maintainers' 27 | github 'nebula-plugins' 28 | } 29 | } 30 | 31 | dependencies { 32 | implementation 'commons-beanutils:commons-beanutils-core:1.8.3' 33 | testImplementation 'org.apache.commons:commons-lang3:3.3.2' 34 | } 35 | 36 | 37 | gradlePlugin { 38 | plugins { 39 | override { 40 | id = 'com.netflix.nebula.override' 41 | displayName = 'Gradle Override plugin' 42 | description = project.description 43 | implementationClass = 'nebula.plugin.override.NebulaOverridePlugin' 44 | tags.set(['nebula', 'override']) 45 | } 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /dependencies.lock: -------------------------------------------------------------------------------- 1 | { 2 | "compileClasspath": { 3 | "commons-beanutils:commons-beanutils-core": { 4 | "locked": "1.8.3" 5 | } 6 | }, 7 | "integTestCompileClasspath": { 8 | "com.netflix.nebula:nebula-test": { 9 | "locked": "10.1.0" 10 | }, 11 | "commons-beanutils:commons-beanutils-core": { 12 | "locked": "1.8.3" 13 | }, 14 | "org.apache.commons:commons-lang3": { 15 | "locked": "3.3.2" 16 | } 17 | }, 18 | "integTestRuntimeClasspath": { 19 | "com.netflix.nebula:nebula-test": { 20 | "locked": "10.1.0" 21 | }, 22 | "commons-beanutils:commons-beanutils-core": { 23 | "locked": "1.8.3" 24 | }, 25 | "org.apache.commons:commons-lang3": { 26 | "locked": "3.3.2" 27 | } 28 | }, 29 | "jacocoAgent": { 30 | "org.jacoco:org.jacoco.agent": { 31 | "locked": "0.8.7" 32 | } 33 | }, 34 | "jacocoAnt": { 35 | "org.jacoco:org.jacoco.ant": { 36 | "locked": "0.8.7" 37 | } 38 | }, 39 | "runtimeClasspath": { 40 | "commons-beanutils:commons-beanutils-core": { 41 | "locked": "1.8.3" 42 | } 43 | }, 44 | "testCompileClasspath": { 45 | "com.netflix.nebula:nebula-test": { 46 | "locked": "10.1.0" 47 | }, 48 | "commons-beanutils:commons-beanutils-core": { 49 | "locked": "1.8.3" 50 | }, 51 | "org.apache.commons:commons-lang3": { 52 | "locked": "3.3.2" 53 | } 54 | }, 55 | "testRuntimeClasspath": { 56 | "com.netflix.nebula:nebula-test": { 57 | "locked": "10.1.0" 58 | }, 59 | "commons-beanutils:commons-beanutils-core": { 60 | "locked": "1.8.3" 61 | }, 62 | "org.apache.commons:commons-lang3": { 63 | "locked": "3.3.2" 64 | } 65 | } 66 | } -------------------------------------------------------------------------------- /gradle.properties.enc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nebula-plugins/gradle-override-plugin/eb26a580781d51a98beb523328befc55feb17f51/gradle.properties.enc -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nebula-plugins/gradle-override-plugin/eb26a580781d51a98beb523328befc55feb17f51/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-rc-1-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 87 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit 88 | 89 | # Use the maximum available, or set MAX_FD != -1 to use that value. 90 | MAX_FD=maximum 91 | 92 | warn () { 93 | echo "$*" 94 | } >&2 95 | 96 | die () { 97 | echo 98 | echo "$*" 99 | echo 100 | exit 1 101 | } >&2 102 | 103 | # OS specific support (must be 'true' or 'false'). 104 | cygwin=false 105 | msys=false 106 | darwin=false 107 | nonstop=false 108 | case "$( uname )" in #( 109 | CYGWIN* ) cygwin=true ;; #( 110 | Darwin* ) darwin=true ;; #( 111 | MSYS* | MINGW* ) msys=true ;; #( 112 | NONSTOP* ) nonstop=true ;; 113 | esac 114 | 115 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 116 | 117 | 118 | # Determine the Java command to use to start the JVM. 119 | if [ -n "$JAVA_HOME" ] ; then 120 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 121 | # IBM's JDK on AIX uses strange locations for the executables 122 | JAVACMD=$JAVA_HOME/jre/sh/java 123 | else 124 | JAVACMD=$JAVA_HOME/bin/java 125 | fi 126 | if [ ! -x "$JAVACMD" ] ; then 127 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 128 | 129 | Please set the JAVA_HOME variable in your environment to match the 130 | location of your Java installation." 131 | fi 132 | else 133 | JAVACMD=java 134 | if ! command -v java >/dev/null 2>&1 135 | then 136 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | fi 142 | 143 | # Increase the maximum file descriptors if we can. 144 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 145 | case $MAX_FD in #( 146 | max*) 147 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 148 | # shellcheck disable=SC2039,SC3045 149 | MAX_FD=$( ulimit -H -n ) || 150 | warn "Could not query maximum file descriptor limit" 151 | esac 152 | case $MAX_FD in #( 153 | '' | soft) :;; #( 154 | *) 155 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 156 | # shellcheck disable=SC2039,SC3045 157 | ulimit -n "$MAX_FD" || 158 | warn "Could not set maximum file descriptor limit to $MAX_FD" 159 | esac 160 | fi 161 | 162 | # Collect all arguments for the java command, stacking in reverse order: 163 | # * args from the command line 164 | # * the main class name 165 | # * -classpath 166 | # * -D...appname settings 167 | # * --module-path (only if needed) 168 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 169 | 170 | # For Cygwin or MSYS, switch paths to Windows format before running java 171 | if "$cygwin" || "$msys" ; then 172 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 173 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -classpath "$CLASSPATH" \ 214 | org.gradle.wrapper.GradleWrapperMain \ 215 | "$@" 216 | 217 | # Stop when "xargs" is not available. 218 | if ! command -v xargs >/dev/null 2>&1 219 | then 220 | die "xargs is not available" 221 | fi 222 | 223 | # Use "xargs" to parse quoted args. 224 | # 225 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 226 | # 227 | # In Bash we could simply go: 228 | # 229 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 230 | # set -- "${ARGS[@]}" "$@" 231 | # 232 | # but POSIX shell has neither arrays nor command substitution, so instead we 233 | # post-process each arg (as a line of input to sed) to backslash-escape any 234 | # character that might be a shell metacharacter, then use eval to reverse 235 | # that process (while maintaining the separation between arguments), and wrap 236 | # the whole thing up as a single "set" statement. 237 | # 238 | # This will of course break if any of these variables contains a newline or 239 | # an unmatched quote. 240 | # 241 | 242 | eval "set -- $( 243 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 244 | xargs -n1 | 245 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 246 | tr '\n' ' ' 247 | )" '"$@"' 248 | 249 | exec "$JAVACMD" "$@" 250 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 48 | echo. 49 | echo Please set the JAVA_HOME variable in your environment to match the 50 | echo location of your Java installation. 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 62 | echo. 63 | echo Please set the JAVA_HOME variable in your environment to match the 64 | echo location of your Java installation. 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'gradle-override-plugin' 2 | 3 | -------------------------------------------------------------------------------- /src/main/groovy/nebula/plugin/override/DotNotationWalkerOverrideStrategy.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override 2 | 3 | import nebula.plugin.override.converter.ApacheCommonsTypeConverter 4 | import nebula.plugin.override.converter.TypeConverter 5 | import org.codehaus.groovy.runtime.NullObject 6 | import org.gradle.api.Project 7 | 8 | class DotNotationWalkerOverrideStrategy implements OverrideStrategy { 9 | TypeConverter typeConverter = new ApacheCommonsTypeConverter() 10 | 11 | @Override 12 | void apply(Project project, String propertyName, String overrideValue) { 13 | String[] extractedOptions = propertyName.split('\\.') 14 | 15 | def node = project 16 | def parent = null 17 | def fieldName = null 18 | 19 | extractedOptions.eachWithIndex { String entry, int index -> 20 | if(index == extractedOptions.size() - 1) { 21 | parent = node 22 | fieldName = entry 23 | } 24 | 25 | node = determineProperty(node, entry, propertyName) 26 | } 27 | 28 | Class clazz = node.getClass() 29 | 30 | // If no value is assigned, determine the property's class via the parent's metaClass 31 | if(clazz == NullObject) { 32 | clazz = parent.class.metaClass.properties.find { it.name == fieldName }.type 33 | } 34 | 35 | parent.setProperty(fieldName, typeConverter.convert(overrideValue, clazz)) 36 | } 37 | 38 | /** 39 | * Checks if node has a property with the provided name. 40 | * 41 | * @param node Gradle domain object 42 | * @param propertyName Property name 43 | * @return Property instance 44 | * @throws UnknownPropertyException 45 | */ 46 | def determineProperty(Object node, String propertyName, String fullOverridePath) { 47 | if(node.hasProperty(propertyName)) { 48 | return node.getProperty(propertyName) 49 | } 50 | 51 | throw new UnknownPropertyException("Unknown property with name '$propertyName' on instance of type ${node.getClass()} (Full property path: '$fullOverridePath')") 52 | } 53 | } -------------------------------------------------------------------------------- /src/main/groovy/nebula/plugin/override/NebulaOverridePlugin.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override 2 | 3 | import nebula.plugin.override.reader.AggregateOverrideReader 4 | import nebula.plugin.override.reader.OverrideReader 5 | import org.gradle.api.Plugin 6 | import org.gradle.api.Project 7 | 8 | /** 9 | * Plugin for overriding properties in a project from the command line. The main use case for this functionality is to 10 | * avoid the introduction of "magic" system/project properties for providing user-driven property values as part of build 11 | * logic. Property names are provided as String and are looked up by dot notation. If no matching property can be resolved, 12 | * the build fails. 13 | */ 14 | class NebulaOverridePlugin implements Plugin { 15 | 16 | void apply(Project project) { 17 | OverrideReader overrideReader = new AggregateOverrideReader() 18 | def overrideProperties = overrideReader.parseProperties() 19 | 20 | project.afterEvaluate { 21 | List upes = new ArrayList(); 22 | overrideProperties.each { propertyName, overrideValue -> 23 | project.logger.info "Overriding property '$propertyName' with '$overrideValue'." 24 | OverrideStrategy dotNotationWalkerOverrideStrategy = new DotNotationWalkerOverrideStrategy() 25 | try { 26 | dotNotationWalkerOverrideStrategy.apply(project, propertyName, overrideValue) 27 | } catch(UnknownPropertyException upe) { 28 | upes.add(upe) 29 | } 30 | } 31 | // TODO Use warning plugin to report on unfound properties 32 | upes.each { upe -> 33 | project.logger.warn(upe.getMessage()); 34 | } 35 | } 36 | } 37 | } -------------------------------------------------------------------------------- /src/main/groovy/nebula/plugin/override/OverrideStrategy.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override 2 | 3 | import org.gradle.api.Project 4 | 5 | interface OverrideStrategy { 6 | void apply(Project project, String propertyName, String overrideValue) 7 | } -------------------------------------------------------------------------------- /src/main/groovy/nebula/plugin/override/UnknownPropertyException.java: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override; 2 | 3 | public class UnknownPropertyException extends RuntimeException { 4 | public UnknownPropertyException(String message) { 5 | super(message); 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/main/groovy/nebula/plugin/override/converter/ApacheCommonsTypeConverter.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override.converter 2 | 3 | import org.apache.commons.beanutils.ConvertUtilsBean 4 | 5 | class ApacheCommonsTypeConverter implements TypeConverter { 6 | ConvertUtilsBean convertUtilsBean = new ConvertUtilsBean() 7 | 8 | @Override 9 | Object convert(String value, Class clazz) { 10 | convertUtilsBean.convert(value, clazz) 11 | } 12 | } -------------------------------------------------------------------------------- /src/main/groovy/nebula/plugin/override/converter/TypeConverter.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override.converter 2 | 3 | interface TypeConverter { 4 | Object convert(String value, Class clazz) 5 | } -------------------------------------------------------------------------------- /src/main/groovy/nebula/plugin/override/reader/AggregateOverrideReader.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override.reader 2 | 3 | /** 4 | * Aggregate override reader with a predefined list of implementations. 5 | */ 6 | class AggregateOverrideReader implements OverrideReader { 7 | List overrideReaders = [] as List 8 | 9 | AggregateOverrideReader() { 10 | overrideReaders << new EnvironmentVariableOverrideReader() 11 | overrideReaders << new SystemPropertyOverrideReader() 12 | } 13 | 14 | @Override 15 | Map parseProperties() { 16 | Map properties = [:] as Map 17 | 18 | overrideReaders.each { reader -> 19 | properties.putAll(reader.parseProperties()) 20 | } 21 | 22 | properties 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/main/groovy/nebula/plugin/override/reader/EnvironmentVariableOverrideReader.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override.reader 2 | 3 | /** 4 | * Parses override properties from environment variables prefixed with "OVERRIDE_". 5 | * 6 | * Example: 7 | * 8 | * 
 9 |  *     export OVERRIDE_example.test=replace
10 |  *
11 | */ 12 | class EnvironmentVariableOverrideReader implements OverrideReader { 13 | static final String OVERRIDE_PROPERTY_PREFIX = 'OVERRIDE_' 14 | 15 | @Override 16 | Map parseProperties() { 17 | def overrideProperties = System.getenv().findAll { it.key.startsWith(OVERRIDE_PROPERTY_PREFIX) } 18 | // Remove property prefix 19 | overrideProperties.collectEntries { key, value -> [key - OVERRIDE_PROPERTY_PREFIX, value] } 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /src/main/groovy/nebula/plugin/override/reader/OverrideReader.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override.reader 2 | 3 | interface OverrideReader { 4 | Map parseProperties() 5 | } -------------------------------------------------------------------------------- /src/main/groovy/nebula/plugin/override/reader/SystemPropertyOverrideReader.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override.reader 2 | 3 | /** 4 | * Parses override properties from system properties prefixed with "override.". 5 | * 6 | * Example: 7 | * 8 | * 
 9 |  *     -Doverride.example.test=replace
10 |  *
11 | */ 12 | class SystemPropertyOverrideReader implements OverrideReader { 13 | static final String OVERRIDE_PROPERTY_PREFIX = 'override.' 14 | 15 | /** 16 | * Parsed properties with the expected prefix. 17 | * 18 | * @return Override properties without prefix as key/value pairs 19 | */ 20 | @Override 21 | Map parseProperties() { 22 | def overrideProperties = System.properties.findAll { it.key.startsWith(OVERRIDE_PROPERTY_PREFIX) } 23 | // Remove property prefix 24 | overrideProperties.collectEntries { key, value -> [key - OVERRIDE_PROPERTY_PREFIX, value] } 25 | } 26 | } -------------------------------------------------------------------------------- /src/test/groovy/nebula/plugin/override/DotNotationWalkerOverrideStrategyTest.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override 2 | 3 | import nebula.test.ProjectSpec 4 | import org.gradle.api.tasks.bundling.Jar 5 | 6 | class DotNotationWalkerOverrideStrategyTest extends ProjectSpec { 7 | OverrideStrategy genericOverrideStrategy = new DotNotationWalkerOverrideStrategy() 8 | 9 | def "Throws exception if property cannot be resolved"() { 10 | when: 11 | genericOverrideStrategy.apply(project, 'doesntExist', 'test') 12 | 13 | then: 14 | Throwable t = thrown(UnknownPropertyException) 15 | t.message == "Unknown property with name 'doesntExist' on instance of type class org.gradle.api.internal.project.DefaultProject_Decorated (Full property path: 'doesntExist')" 16 | } 17 | 18 | def "Can override project property"() { 19 | given: 20 | project.version = '1.0' 21 | 22 | when: 23 | genericOverrideStrategy.apply(project, 'version', '2.0') 24 | 25 | then: 26 | project.version == '2.0' 27 | } 28 | 29 | def "Can override project extra property"() { 30 | given: 31 | project.ext.myProp = 'test' 32 | 33 | when: 34 | genericOverrideStrategy.apply(project, 'myProp', 'hello') 35 | 36 | then: 37 | project.myProp == 'hello' 38 | } 39 | 40 | def "Can override task property"() { 41 | given: 42 | project.task('jar', type: Jar) 43 | assert project.tasks.findByName('jar') 44 | assert !project.jar.archiveAppendix.isPresent() 45 | 46 | when: 47 | genericOverrideStrategy.apply(project, 'jar.archiveAppendix', 'myAppendix') 48 | 49 | then: 50 | project.jar.archiveAppendix.get() == 'myAppendix' 51 | } 52 | 53 | def "Can override task extra property"() { 54 | given: 55 | project.task('myTask') { 56 | ext.myProp = 'test' 57 | } 58 | assert project.tasks.findByName('myTask') 59 | assert project.myTask.myProp == 'test' 60 | 61 | when: 62 | genericOverrideStrategy.apply(project, 'myTask.myProp', 'hello') 63 | 64 | then: 65 | project.myTask.myProp == 'hello' 66 | } 67 | } -------------------------------------------------------------------------------- /src/test/groovy/nebula/plugin/override/NebulaOverridePluginIntegrationTest.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override 2 | 3 | import nebula.test.IntegrationTestKitSpec 4 | import spock.lang.Issue 5 | 6 | class NebulaOverridePluginIntegrationTest extends IntegrationTestKitSpec { 7 | def setup() { 8 | buildFile << """ 9 | plugins { 10 | id 'com.netflix.nebula.override' 11 | } 12 | """ 13 | } 14 | 15 | def "Warn if property to be overriden cannot be resolved"() { 16 | setup: 17 | System.setProperty('override.example.myProp', 'replaced') 18 | 19 | when: 20 | def executionResult = runTasks('tasks') 21 | 22 | then: 23 | executionResult.output.contains("Unknown property with name 'example' on instance of type class org.gradle.api.internal.project.DefaultProject_Decorated (Full property path: 'example.myProp')") 24 | 25 | cleanup: 26 | System.clearProperty('override.example.myProp') 27 | } 28 | 29 | def "Can override standard and custom project properties"() { 30 | setup: 31 | System.setProperty('override.myProp', 'replaced') 32 | System.setProperty('override.otherProp', '1') 33 | System.setProperty('override.buildDir', 'target') 34 | 35 | buildFile << """ 36 | ext { 37 | myProp = 'test' 38 | otherProp = 0 39 | } 40 | 41 | assert ext.myProp == 'test' 42 | assert ext.otherProp == 0 43 | 44 | task checkOverridenProperties { 45 | doLast { 46 | assert myProp == 'replaced' 47 | assert otherProp == 1 48 | assert buildDir == project.file('target') 49 | } 50 | } 51 | """ 52 | 53 | when: 54 | def executionResult = runTasks('checkOverridenProperties') 55 | 56 | then: 57 | executionResult.output.contains(':checkOverridenProperties') 58 | 59 | cleanup: 60 | System.clearProperty('override.myProp') 61 | System.clearProperty('override.otherProp') 62 | System.clearProperty('override.buildDir') 63 | } 64 | 65 | def "Can override task extra properties"() { 66 | setup: 67 | System.setProperty('override.myTask.myProp', 'replaced') 68 | System.setProperty('override.myTask.otherProp', '1') 69 | 70 | buildFile << """ 71 | task myTask { 72 | ext { 73 | myProp = 'test' 74 | otherProp = 0 75 | } 76 | } 77 | 78 | assert myTask.myProp == 'test' 79 | assert myTask.otherProp == 0 80 | 81 | task checkOverridenProperties { 82 | doLast { 83 | assert myTask.myProp == 'replaced' 84 | assert myTask.otherProp == 1 85 | } 86 | } 87 | """ 88 | 89 | when: 90 | def executionResult = runTasks('checkOverridenProperties') 91 | 92 | then: 93 | executionResult.output.contains(':checkOverridenProperties') 94 | 95 | cleanup: 96 | System.clearProperty('override.myTask.myProp') 97 | System.clearProperty('override.myTask.otherProp') 98 | } 99 | 100 | def "Can override custom task input and output properties"() { 101 | setup: 102 | System.setProperty('override.myTask.myProp', 'replaced') 103 | System.setProperty('override.myTask.otherProp', '1') 104 | System.setProperty('override.myTask.output', 'target') 105 | 106 | buildFile << """ 107 | class MyTask extends DefaultTask { 108 | @Input 109 | String myProp 110 | 111 | @Input 112 | Integer otherProp 113 | 114 | @OutputFile 115 | File output 116 | 117 | @TaskAction 118 | void doNothing() {} 119 | } 120 | 121 | task myTask(type: MyTask) { 122 | myProp = 'test' 123 | otherProp = 0 124 | output = project.file('output') 125 | } 126 | 127 | task checkOverridenProperties { 128 | doLast { 129 | assert myTask.myProp == 'replaced' 130 | assert myTask.otherProp == 1 131 | assert myTask.output == new File('target') 132 | } 133 | } 134 | """ 135 | 136 | when: 137 | def executionResult = runTasks('checkOverridenProperties') 138 | 139 | then: 140 | executionResult.output.contains(':checkOverridenProperties') 141 | 142 | cleanup: 143 | System.clearProperty('override.myTask.myProp') 144 | System.clearProperty('override.myTask.otherProp') 145 | System.clearProperty('override.myTask.output') 146 | } 147 | 148 | def "Can override properties provided by java plugin"() { 149 | setup: 150 | System.setProperty('override.sourceCompatibility', '1.7') 151 | System.setProperty('override.targetCompatibility', '1.7') 152 | System.setProperty('override.testResultsDirName', 'my-test-results') 153 | System.setProperty('override.javadoc.maxMemory', '1024m') 154 | 155 | buildFile << """ 156 | apply plugin: 'java' 157 | 158 | java { 159 | sourceCompatibility = '1.6' 160 | targetCompatibility = '1.6' 161 | } 162 | assert !javadoc.maxMemory 163 | 164 | task checkOverridenProperties { 165 | doLast { 166 | assert sourceCompatibility == JavaVersion.VERSION_1_7 167 | assert targetCompatibility == JavaVersion.VERSION_1_7 168 | assert testResultsDirName == 'my-test-results' 169 | assert javadoc.maxMemory == '1024m' 170 | } 171 | } 172 | """ 173 | System.setProperty('ignoreDeprecations', 'true') 174 | when: 175 | def executionResult = runTasks('checkOverridenProperties') 176 | 177 | then: 178 | executionResult.output.contains(':checkOverridenProperties') 179 | 180 | cleanup: 181 | System.clearProperty('override.sourceCompatibility') 182 | System.clearProperty('override.targetCompatibility') 183 | System.clearProperty('override.testResultsDirName') 184 | System.clearProperty('override.javadoc.maxMemory') 185 | } 186 | 187 | def "Can override deeply-nested extension properties"() { 188 | setup: 189 | System.setProperty('override.example.myProp', 'replaced') 190 | System.setProperty('override.example.nested.otherProp', '1') 191 | System.setProperty('override.example.nested.deeper.deep', 'true') 192 | 193 | buildFile << """ 194 | class MyExtension { 195 | String myProp = 'test' 196 | Nested nested = new Nested() 197 | 198 | class Nested { 199 | Integer otherProp = 0 200 | Deeper deeper = new Deeper() 201 | 202 | class Deeper { 203 | Boolean deep = Boolean.FALSE 204 | } 205 | } 206 | } 207 | 208 | extensions.create('example', MyExtension) 209 | 210 | assert example.myProp == 'test' 211 | assert example.nested.otherProp == 0 212 | assert !example.nested.deeper.deep 213 | 214 | task checkOverridenProperties { 215 | doLast { 216 | assert example.myProp == 'replaced' 217 | assert example.nested.otherProp == 1 218 | assert example.nested.deeper.deep 219 | } 220 | } 221 | """ 222 | 223 | when: 224 | def executionResult = runTasks('checkOverridenProperties') 225 | 226 | then: 227 | executionResult.output.contains(':checkOverridenProperties') 228 | 229 | cleanup: 230 | System.clearProperty('override.example.myProp') 231 | System.clearProperty('override.example.nested.otherProp') 232 | System.clearProperty('override.example.nested.deeper.deep') 233 | } 234 | 235 | @Issue("https://github.com/nebula-plugins/gradle-override-plugin/issues/1") 236 | def "Should allow to override not initialized Boolean property with false value"() { 237 | given: 238 | buildFile << """ 239 | class MyExtension { 240 | String myProp 241 | Boolean myBoolean 242 | } 243 | 244 | extensions.create('example', MyExtension) 245 | 246 | assert example.myProp == null 247 | assert example.myBoolean == null 248 | 249 | task checkOverridenProperties { 250 | doLast { 251 | assert example.myProp == 'test' 252 | assert example.myBoolean == false 253 | } 254 | } 255 | """ 256 | 257 | when: 258 | def executionResult = runTasks('checkOverridenProperties', '-Doverride.example.myProp=test', 259 | '-Doverride.example.myBoolean=false') 260 | 261 | then: 262 | executionResult.output.contains(':checkOverridenProperties') 263 | 264 | cleanup: 'Left over from inprocess tests' 265 | System.clearProperty('override.example.myProp') 266 | System.clearProperty('override.example.myBoolean') 267 | } 268 | } 269 | -------------------------------------------------------------------------------- /src/test/groovy/nebula/plugin/override/converter/ApacheCommonsTypeConverterTest.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override.converter 2 | 3 | import spock.lang.Specification 4 | import spock.lang.Unroll 5 | 6 | class ApacheCommonsTypeConverterTest extends Specification { 7 | TypeConverter typeConverter = new ApacheCommonsTypeConverter() 8 | 9 | @Unroll 10 | def "Can convert '#valueString' to #convertedType"() { 11 | expect: 12 | def convertedValue = typeConverter.convert(valueString, convertedType) 13 | convertedValue.getClass() == convertedType 14 | convertedValue == typedValue 15 | 16 | where: 17 | valueString | convertedType | typedValue 18 | '100' | java.lang.Byte.class | 100 19 | '10' | java.lang.Short.class | 10 20 | 'A' | java.lang.Character.class | 'A' 21 | 'test' | java.lang.String.class | 'test' 22 | '1' | java.lang.Integer.class | 1 23 | '1' | java.lang.Long.class | 1L 24 | 'true' | java.lang.Boolean.class | true 25 | '1.5' | java.lang.Float.class | 1.5f 26 | '1.5' | java.lang.Double.class | 1.5d 27 | '/usr/bin/test' | java.io.File.class | new File('/usr/bin/test') 28 | } 29 | } -------------------------------------------------------------------------------- /src/test/groovy/nebula/plugin/override/reader/AggregateOverrideReaderTest.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override.reader 2 | 3 | import spock.lang.Specification 4 | 5 | class AggregateOverrideReaderTest extends Specification { 6 | AggregateOverrideReader aggregateOverrideReader = new AggregateOverrideReader() 7 | 8 | def "Has registered default readers in expected order"() { 9 | expect: 10 | aggregateOverrideReader.overrideReaders.size() == 2 11 | aggregateOverrideReader.overrideReaders[0] instanceof EnvironmentVariableOverrideReader 12 | aggregateOverrideReader.overrideReaders[1] instanceof SystemPropertyOverrideReader 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/test/groovy/nebula/plugin/override/reader/EnvironmentVariableOverrideReaderTest.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override.reader 2 | 3 | import spock.lang.Specification 4 | 5 | class EnvironmentVariableOverrideReaderTest extends Specification { 6 | OverrideReader environmentVariableOverrideReader = new EnvironmentVariableOverrideReader() 7 | 8 | def "No override properties are provided"() { 9 | when: 10 | Map overrideProperties = environmentVariableOverrideReader.parseProperties() 11 | 12 | then: 13 | overrideProperties.isEmpty() 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /src/test/groovy/nebula/plugin/override/reader/SystemPropertyOverrideReaderTest.groovy: -------------------------------------------------------------------------------- 1 | package nebula.plugin.override.reader 2 | 3 | import spock.lang.Specification 4 | 5 | class SystemPropertyOverrideReaderTest extends Specification { 6 | OverrideReader systemPropertyOverrideReader = new SystemPropertyOverrideReader() 7 | 8 | def "No override properties are provided"() { 9 | when: 10 | Map overrideProperties = systemPropertyOverrideReader.parseProperties() 11 | 12 | then: 13 | overrideProperties.isEmpty() 14 | } 15 | 16 | def "Override properties are parsed and stripped of prefix"() { 17 | setup: 18 | System.setProperty('override.example.test', 'prop1') 19 | System.setProperty('override.myPlugin.name', 'prop2') 20 | 21 | when: 22 | Map overrideProperties = systemPropertyOverrideReader.parseProperties() 23 | 24 | then: 25 | !overrideProperties.isEmpty() 26 | overrideProperties.containsKey('example.test') 27 | overrideProperties.containsKey('myPlugin.name') 28 | overrideProperties['example.test'] == 'prop1' 29 | overrideProperties['myPlugin.name'] == 'prop2' 30 | 31 | cleanup: 32 | System.clearProperty('override.example.test') 33 | System.clearProperty('override.myPlugin.name') 34 | } 35 | } --------------------------------------------------------------------------------