diff --git a/java-repo-tools/.gitignore b/java-repo-tools/.gitignore new file mode 100644 index 00000000000..342c18bf686 --- /dev/null +++ b/java-repo-tools/.gitignore @@ -0,0 +1,26 @@ +service-account.json + +### Java ### +*.class + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.ear + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +# Maven +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +release.properties +dependency-reduced-pom.xml +buildNumber.properties +.mvn/timing.properties diff --git a/java-repo-tools/.travis.yml b/java-repo-tools/.travis.yml new file mode 100644 index 00000000000..bb7197c540d --- /dev/null +++ b/java-repo-tools/.travis.yml @@ -0,0 +1,23 @@ +# Copyright 2016 Google Inc. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +language: java +jdk: + - oraclejdk7 + - oraclejdk8 +script: mvn verify +after_success: + - mvn clean cobertura:cobertura coveralls:report +branches: + only: + - master diff --git a/java-repo-tools/CONTRIBUTING.md b/java-repo-tools/CONTRIBUTING.md new file mode 100644 index 00000000000..6736efd943c --- /dev/null +++ b/java-repo-tools/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# How to become a contributor and submit your own code + +## Contributor License Agreements + +We'd love to accept your sample apps and patches! Before we can take them, we +have to jump a couple of legal hurdles. + +Please fill out either the individual or corporate Contributor License Agreement +(CLA). + + * If you are an individual writing original source code and you're sure you + own the intellectual property, then you'll need to sign an [individual CLA] + (https://developers.google.com/open-source/cla/individual). + * If you work for a company that wants to allow you to contribute your work, + then you'll need to sign a [corporate CLA] + (https://developers.google.com/open-source/cla/corporate). + +Follow either of the two links above to access the appropriate CLA and +instructions for how to sign and return it. Once we receive it, we'll be able to +accept your pull requests. + +## Contributing A Patch + +1. Submit an issue describing your proposed change to the repo in question. +1. The repo owner will respond to your issue promptly. +1. If your proposed change is accepted, and you haven't already done so, sign a + Contributor License Agreement (see details above). +1. Fork the desired repo, develop and test your code changes. +1. Ensure that your code adheres to the existing style in the sample to which + you are contributing. Refer to the + [Google Cloud Platform Samples Style Guide] + (https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the + recommended coding standards for this organization. +1. Ensure that your code has an appropriate set of unit tests which all pass. +1. Submit a pull request. diff --git a/java-repo-tools/LICENSE b/java-repo-tools/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/java-repo-tools/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/java-repo-tools/README.md b/java-repo-tools/README.md new file mode 100644 index 00000000000..0a9b3c652e5 --- /dev/null +++ b/java-repo-tools/README.md @@ -0,0 +1,19 @@ +# Cloud Platform Java Repository Tools + +[![Build +Status](https://travis-ci.org/GoogleCloudPlatform/java-repo-tools.svg?branch=master)](https://travis-ci.org/GoogleCloudPlatform/java-repo-tools) + +This is a collection of common tools used to maintain and test Java repositories +in the [GoogleCloudPlaftorm](https://github.com/GoogleCloudPlatform) +organization. + + +## Contributing changes + +- See [CONTRIBUTING.md](CONTRIBUTING.md) + + +## Licensing + +- Apache 2.0 - See [LICENSE](LICENSE) + diff --git a/google-checks.xml b/java-repo-tools/google-checks.xml similarity index 100% rename from google-checks.xml rename to java-repo-tools/google-checks.xml diff --git a/java-repo-tools/pom.xml b/java-repo-tools/pom.xml new file mode 100644 index 00000000000..e86bda86f7b --- /dev/null +++ b/java-repo-tools/pom.xml @@ -0,0 +1,106 @@ + + + 4.0.0 + 1.0.0 + + com.google.cloud + shared-configuration + pom + + + UTF-8 + UTF-8 + + + + 3.1.0 + + + + test + + + + + + + org.apache.maven.plugins + maven-surefire-plugin + 2.19.1 + + false + + + + + org.apache.maven.plugins + maven-failsafe-plugin + 2.19.1 + + + + integration-test + verify + + + + + + org.apache.maven.plugins + maven-checkstyle-plugin + 2.17 + + google-checks.xml + true + true + true + true + suppressions.xml + + + check + + + + org.eluder.coveralls + coveralls-maven-plugin + 3.1.0 + + + ${basedir}/target/coverage.xml + + + + + org.codehaus.mojo + cobertura-maven-plugin + 2.6 + + ${basedir}/target + + xml + html + + xml + 256m + + true + + + + + diff --git a/suppressions.xml b/java-repo-tools/suppressions.xml similarity index 100% rename from suppressions.xml rename to java-repo-tools/suppressions.xml diff --git a/java-repo-tools/test/README.md b/java-repo-tools/test/README.md new file mode 100644 index 00000000000..59e4015515c --- /dev/null +++ b/java-repo-tools/test/README.md @@ -0,0 +1,5 @@ +# Cloud Platform Java Repository Tools Test + +This is a test application for checking that the root [`pom.xml`](../pom.xml) +and [`google-checks.xml`](../google-checks.xml) are working as expected. + diff --git a/java-repo-tools/test/pom.xml b/java-repo-tools/test/pom.xml new file mode 100644 index 00000000000..96f42c5f06a --- /dev/null +++ b/java-repo-tools/test/pom.xml @@ -0,0 +1,48 @@ + + + + 4.0.0 + + com.google.cloud + shared-configuration-test + 1.0 + jar + + + shared-configuration + com.google.cloud + 1.0.0 + .. + + + + + + junit + junit + 4.12 + test + + + com.google.truth + truth + 0.27 + test + + + diff --git a/java-repo-tools/test/src/main/java/com/google/cloud/samples/test/App.java b/java-repo-tools/test/src/main/java/com/google/cloud/samples/test/App.java new file mode 100644 index 00000000000..244b1507594 --- /dev/null +++ b/java-repo-tools/test/src/main/java/com/google/cloud/samples/test/App.java @@ -0,0 +1,30 @@ +/* + * Copyright 2016 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.google.cloud.samples.test; + +/** + * A hello world app to test the parent pom.xml. + */ +public class App { + public static String greeting() { + return "Hello World!"; + } + + public static void main(String[] args) { + System.out.println(App.greeting()); + } +} diff --git a/java-repo-tools/test/src/test/java/com/google/cloud/samples/test/AppTest.java b/java-repo-tools/test/src/test/java/com/google/cloud/samples/test/AppTest.java new file mode 100644 index 00000000000..ab7f5095aae --- /dev/null +++ b/java-repo-tools/test/src/test/java/com/google/cloud/samples/test/AppTest.java @@ -0,0 +1,33 @@ +/* + * Copyright 2016 Google Inc. All Rights Reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.google.cloud.samples.test; + +import static com.google.common.truth.Truth.assertThat; + +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.JUnit4; + +/** + * Unit tests for {@link App}. + */ +@RunWith(JUnit4.class) +public class AppTest { + @Test public void greeting_returnsHelloWorld() { + assertThat(App.greeting()).named("greeting").isEqualTo("Hello World!"); + } +} diff --git a/pom.xml b/pom.xml index 7dcab2a0023..8ff178a7a56 100644 --- a/pom.xml +++ b/pom.xml @@ -21,10 +21,17 @@ doc-samples pom + + + com.google.cloud + shared-configuration + 1.0.0 + java-repo-tools + + 1.9.34 1 - UTF-8 1.19.0 1.19.0 1.7 @@ -65,54 +72,6 @@ unittests - - - - org.apache.maven.plugins - maven-checkstyle-plugin - 2.17 - - google-checks.xml - true - true - true - true - suppressions.xml - - - check - - - - org.eluder.coveralls - coveralls-maven-plugin - 3.1.0 - - - ${basedir}/target/coverage.xml - - - - - org.codehaus.mojo - cobertura-maven-plugin - 2.6 - - ${basedir}/target - - xml - html - - xml - 256m - - true - - - - - -