├── .gitignore
├── src
├── test
│ ├── resources
│ │ ├── docker-compose-selenium-standalone-chrome.yml
│ │ └── logback.xml
│ └── java
│ │ └── schulte
│ │ └── markus
│ │ └── seleniumstandalonechromespringboot
│ │ └── controller
│ │ └── HelloControllerIT.java
└── main
│ └── java
│ └── schulte
│ └── markus
│ └── seleniumstandalonechromespringboot
│ ├── Application.java
│ └── controller
│ └── HelloController.java
├── .editorconfig
├── .travis.yml
├── pom.xml
├── README.md
└── LICENSE
/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/
2 | *.iml
3 | target/
4 |
--------------------------------------------------------------------------------
/src/test/resources/docker-compose-selenium-standalone-chrome.yml:
--------------------------------------------------------------------------------
1 | version: '2'
2 |
3 | services:
4 | selenium-standalone-chrome:
5 | image: selenium/standalone-chrome-debug
6 | ports:
7 | - 4444
8 | - 5900
9 |
--------------------------------------------------------------------------------
/src/test/resources/logback.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | # Using https://google.github.io/styleguide/javaguide.html, download from https://github.com/google/styleguide
2 |
3 | root = true
4 |
5 | [*]
6 | charset = utf-8
7 | end_of_line = LF
8 | insert_final_newline = true
9 | trim_trailing_whitespace = true
10 | indent_style = space
11 | indent_size = 2
12 |
13 | [*.md]
14 | trim_trailing_whitespace = false
15 |
--------------------------------------------------------------------------------
/src/main/java/schulte/markus/seleniumstandalonechromespringboot/Application.java:
--------------------------------------------------------------------------------
1 | package schulte.markus.seleniumstandalonechromespringboot;
2 |
3 | import org.springframework.boot.SpringApplication;
4 | import org.springframework.boot.autoconfigure.SpringBootApplication;
5 |
6 | @SpringBootApplication
7 | public class Application {
8 |
9 | public static void main(String... args) {
10 | SpringApplication.run(Application.class, args);
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/src/main/java/schulte/markus/seleniumstandalonechromespringboot/controller/HelloController.java:
--------------------------------------------------------------------------------
1 | package schulte.markus.seleniumstandalonechromespringboot.controller;
2 |
3 | import org.springframework.stereotype.Controller;
4 | import org.springframework.web.bind.annotation.GetMapping;
5 | import org.springframework.web.bind.annotation.ResponseBody;
6 |
7 | @Controller
8 | public class HelloController {
9 |
10 | @GetMapping
11 | @ResponseBody
12 | public String index() {
13 | return ""
14 | + "
Selenium standalone Chrome / Spring Boot demo"
15 | + "Hello world!
";
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: java
2 | jdk:
3 | - oraclejdk8
4 | cache:
5 | directories:
6 | - $HOME/.m2
7 | sudo: required
8 | services:
9 | - docker
10 | env:
11 | global:
12 | - ARTIFACTS_S3_BUCKET=schultedev-xml-metrics-to-html
13 | - S3_KEY_PREFIX=github/$TRAVIS_REPO_SLUG
14 | - CHECKSTYLE_HTML_REPORT_DIR=target/checkstyle-html-report
15 | addons:
16 | artifacts:
17 | working_dir: $CHECKSTYLE_HTML_REPORT_DIR
18 | paths:
19 | - $(ls $CHECKSTYLE_HTML_REPORT_DIR | tr "\n" ":")
20 | target_paths: $S3_KEY_PREFIX/$TRAVIS_COMMIT/checkstyle/:$S3_KEY_PREFIX/$TRAVIS_BRANCH/checkstyle/
21 |
22 | before_script:
23 | - mkdir $CHECKSTYLE_HTML_REPORT_DIR
24 | - docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"
25 | - docker pull schultedev/checkstyle-xml-to-html
26 | script: mvn verify
27 | after_success:
28 | - mvn versions:display-dependency-updates
29 | - mvn versions:display-plugin-updates
30 | - mvn checkstyle:checkstyle
31 | - docker run --rm
32 | -v $TRAVIS_BUILD_DIR/target/checkstyle-result.xml:/checkstyle-result.xml:ro
33 | -v $TRAVIS_BUILD_DIR/$CHECKSTYLE_HTML_REPORT_DIR:/tmp/checkstyle-html-report/
34 | schultedev/checkstyle-xml-to-html:latest
35 | - "curl -s -o /dev/null -w \"%{http_code}\" -H \"Authorization: token $GH_MS_API_PERSONAL_ACCESS_TOKEN\"
36 | -d \"{\\\"state\\\": \\\"success\\\", \\\"description\\\": \\\"Checkstyle HTML report\\\", \\\"context\\\": \\\"schultedev/Checkstyle\\\", \\\"target_url\\\": \\\"https://s3.amazonaws.com/$ARTIFACTS_S3_BUCKET/$S3_KEY_PREFIX/$TRAVIS_COMMIT/checkstyle/index.html\\\"}\"
37 | https://api.github.com/repos/$TRAVIS_REPO_SLUG/statuses/$TRAVIS_COMMIT"
38 |
--------------------------------------------------------------------------------
/src/test/java/schulte/markus/seleniumstandalonechromespringboot/controller/HelloControllerIT.java:
--------------------------------------------------------------------------------
1 | package schulte.markus.seleniumstandalonechromespringboot.controller;
2 |
3 | import com.palantir.docker.compose.DockerComposeRule;
4 | import com.palantir.docker.compose.connection.DockerPort;
5 | import com.palantir.docker.compose.connection.waiting.HealthChecks;
6 | import io.github.bonigarcia.wdm.ChromeDriverManager;
7 | import java.net.MalformedURLException;
8 | import java.net.URL;
9 | import org.junit.AfterClass;
10 | import org.junit.Assert;
11 | import org.junit.Before;
12 | import org.junit.BeforeClass;
13 | import org.junit.ClassRule;
14 | import org.junit.Test;
15 | import org.junit.runner.RunWith;
16 | import org.openqa.selenium.By;
17 | import org.openqa.selenium.WebDriver;
18 | import org.openqa.selenium.WebElement;
19 | import org.openqa.selenium.remote.DesiredCapabilities;
20 | import org.openqa.selenium.remote.RemoteWebDriver;
21 | import org.springframework.boot.test.context.SpringBootTest;
22 | import org.springframework.boot.web.server.LocalServerPort;
23 | import org.springframework.test.context.junit4.SpringRunner;
24 |
25 | @RunWith(SpringRunner.class)
26 | @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
27 | public class HelloControllerIT {
28 |
29 | /**
30 | * IP of docker0 network on docker-host.
31 | *
32 | * In network_mode=bridge, this value should be fixed, see docs.docker.com
33 | */
34 | private static final String DOCKER0_IP = "172.17.0.1";
35 |
36 | private static final String DOCKER_COMPOSE_YML_FILE
37 | = "src/test/resources/docker-compose-selenium-standalone-chrome.yml";
38 |
39 | private static final int SELENIUM_HUB_PORT = 4444;
40 |
41 | private static final String SELENIUM_STANDALONE_CHROME_SERVICE_NAME
42 | = "selenium-standalone-chrome";
43 |
44 | @ClassRule
45 | public static final DockerComposeRule DOCKER_COMPOSE_RULE = DockerComposeRule.builder()
46 | .file(DOCKER_COMPOSE_YML_FILE)
47 | .pullOnStartup(true)
48 | .waitingForService(SELENIUM_STANDALONE_CHROME_SERVICE_NAME,
49 | HealthChecks.toRespond2xxOverHttp(SELENIUM_HUB_PORT,
50 | (port) -> port.inFormat("http://$HOST:$EXTERNAL_PORT")))
51 | .build();
52 |
53 | private static WebDriver driver;
54 |
55 | @LocalServerPort
56 | private int port;
57 |
58 | private URL base;
59 |
60 | @BeforeClass
61 | public static void initWebDriver() throws MalformedURLException {
62 | ChromeDriverManager.getInstance().setup();
63 |
64 | final DockerPort seleniumStandaloneDockerPort = DOCKER_COMPOSE_RULE.containers()
65 | .container(SELENIUM_STANDALONE_CHROME_SERVICE_NAME).port(SELENIUM_HUB_PORT);
66 | final String remoteSeleniumUrl
67 | = seleniumStandaloneDockerPort.inFormat("http://$HOST:$EXTERNAL_PORT/wd/hub");
68 |
69 | driver = new RemoteWebDriver(new URL(remoteSeleniumUrl), DesiredCapabilities.chrome());
70 | }
71 |
72 | @AfterClass
73 | public static void closeWebDriver() {
74 | driver.close();
75 | }
76 |
77 | @Before
78 | public void setUp() throws MalformedURLException {
79 | /*
80 | * Chrome runs within a docker-container, but the actual Spring Boot application is executed
81 | * on host. So, Chrome has to test against host-address.
82 | */
83 | this.base = new URL("http://" + DOCKER0_IP + ":" + port);
84 | }
85 |
86 | @Test
87 | public void getHello() {
88 | driver.get(base.toString());
89 |
90 | final WebElement h1Element = driver.findElement(By.id("h1-hello"));
91 | Assert.assertEquals("Hello world!", h1Element.getText());
92 | }
93 | }
94 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 | 4.0.0
6 | schulte.markus
7 | selenium-standalone-chrome-spring-boot-demo
8 | 0.0.1-SNAPSHOT
9 | https://schultemarkus.github.io/docker-compose-rule-spark-demo/
10 |
11 | org.springframework.boot
12 | spring-boot-starter-parent
13 | 2.7.18
14 |
15 |
16 | 3.3.9
17 |
18 |
19 | 17
20 | 17
21 | 17
22 | UTF-8
23 | UTF-8
24 | 3.12.0
25 | 2.2.2
26 | 1.9.0
27 | 3.0.0
28 | 8.10.1
29 |
30 |
31 |
32 | palantir-releases
33 | https://dl.bintray.com/palantir/releases
34 |
35 |
36 |
37 |
38 | org.springframework.boot
39 | spring-boot-starter-web
40 |
41 |
42 | org.springframework.boot
43 | spring-boot-starter-test
44 | test
45 |
46 |
47 | org.seleniumhq.selenium
48 | selenium-java
49 | ${selenium.version}
50 | test
51 |
52 |
53 | io.github.bonigarcia
54 | webdrivermanager
55 | ${webdrivermanager.version}
56 | test
57 |
58 |
59 | com.palantir.docker.compose
60 | docker-compose-rule-junit4
61 | ${docker-compose-rule-junit4.version}
62 | test
63 |
64 |
65 |
66 |
67 |
68 | org.springframework.boot
69 | spring-boot-maven-plugin
70 |
71 |
72 | maven-failsafe-plugin
73 |
74 |
75 |
76 | integration-test
77 | verify
78 |
79 |
80 |
81 |
82 |
83 | maven-checkstyle-plugin
84 | ${maven.checkstyle.plugin.version}
85 |
86 |
87 | com.puppycrawl.tools
88 | checkstyle
89 | ${puppycrawl-checkstyle.version}
90 |
91 |
92 |
93 | true
94 | google_checks.xml
95 |
96 |
97 |
98 |
99 |
100 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # [Selenium standalone Chrome / Spring Boot demo](https://github.com/SchulteMarkus/selenium-standalone-chrome-spring-boot-demo)
2 | [](https://gitter.im/selenium-standalone-chrome-spring-boot-demo/Lobby)
3 | [](https://travis-ci.org/SchulteMarkus/selenium-standalone-chrome-spring-boot-demo)
4 | [](https://s3.amazonaws.com/schultedev-xml-metrics-to-html/github/SchulteMarkus/selenium-standalone-chrome-spring-boot-demo/master/checkstyle/index.html)
5 |
6 | Demonstrating [Selenium standalone Chrome](https://github.com/SeleniumHQ/docker-selenium/tree/master/StandaloneChromeDebug) in a
7 | [Spring Boot](https://projects.spring.io/spring-boot/) project.
8 |
9 | ## Challenge
10 |
11 | You got a [Spring Boot](https://projects.spring.io/spring-boot/) application. You want to
12 | integration-test this application with [Selenium](http://www.seleniumhq.org/) using a real browser
13 | like [Google Chrome](https://www.google.de/chrome/browser/desktop/index.html). You are using
14 | [Docker](https://www.docker.com/)([-compose](https://docs.docker.com/compose/)), but you
15 | **don't have an OperatingSystem-GUI available**.
16 |
17 | ## Demo setup
18 |
19 | For this demo, [Spring Boot](https://projects.spring.io/spring-boot/) is used, which ships with a lot
20 | of [build-in integration-test features](https://docs.spring.io/spring/docs/current/spring-framework-reference/html/integration-testing.html).
21 | The application is very simple, it serves *http://localhost:8080/* as a "Hello World"-endpoint, see
22 | [HelloController.java](src/main/java/schulte/markus/seleniumstandalonechromespringboot/controller/HelloController.java).
23 |
24 | ## Demo usage
25 |
26 | **Required**
27 | - [Maven](https://maven.apache.org/)
28 | - [Docker](https://www.docker.com/), including [Docker-compose](https://docs.docker.com/compose/)
29 |
30 | ```bash
31 | selenium-standalone-chrome-spring-boot-demo $ mvn verify
32 | ...
33 | Running schulte.markus.seleniumstandalonechromespringboot.controller.HelloControllerIT
34 | ...
35 | [INFO] BUILD SUCCESS
36 | ```
37 |
38 | ```bash
39 | $ docker ps # While "mvn verify" runs
40 | CONTAINER ID IMAGE ... PORTS NAMES
41 | 2ec2cd60f14a selenium/standalone-chrome-debug ... 0.0.0.0:32779->4444/tcp, 0.0.0.0:32778->5900/tcp a5fc9c37_selenium-standalone-chrome_1
42 | ```
43 |
44 | ## Solution
45 |
46 | I am describing basic setup here. For details, have a look at [HelloControllerIT.java](src/test/java/schulte/markus/seleniumstandalonechromespringboot/controller/HelloControllerIT.java),
47 | which is straight-forward.
48 |
49 | Selenium provides a docker-image [selenium/standalone-chrome](https://hub.docker.com/r/selenium/standalone-chrome-debug/).
50 | You can use this docker-image within your test by using [Docker Compose JUnit Rule](https://github.com/palantir/docker-compose-rule).
51 | You have to use [selenium-java](http://central.maven.org/maven2/org/seleniumhq/selenium/selenium-java/), of course.
52 | By using [WebDriverManager](https://github.com/bonigarcia/webdrivermanager), there is no need to care for downloading
53 | a [Selenium WebDriver](http://www.seleniumhq.org/docs/03_webdriver.jsp) yourself.
54 |
55 | When running [HelloControllerIT.java](src/test/java/schulte/markus/seleniumstandalonechromespringboot/controller/HelloControllerIT.java),
56 | a selenium/standalone-chrome -container is started, while this Spring Boot application is
57 | launched with a random port on localhost. Now in the test, you can use Selenium-RemoteWebDriver to
58 | connect to the running Selenium-Hub within the selenium/standalone-chrome -container.
59 | [Selenium/standalone-chrome-debug](https://hub.docker.com/r/selenium/standalone-chrome-debug/)
60 | docker-images is used here, so you can access VNC on the running container by accessing the published
61 | port 5900.
62 |
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------