diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..f804cc1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,47 @@ +name: Bug Report +description: Please report issues related to TEMPLATE_ADDON here. +body: + - type: textarea + id: problem-description + attributes: + label: Describe the bug + description: A clear description of the issue you're experiencing. + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: A clear and concise description of the expected behavior. + validations: + required: false + - type: textarea + id: minimal-reproduction + attributes: + label: Minimal reproducible example + description: If possible, add a concise code snippet that reproduces the issue and describe the steps needed to follow to reproduce it. + validations: + required: false + - type: input + id: addon-version + attributes: + label: Add-on Version + description: The version of the add-on on which you're experiencing the issue. + validations: + required: true + - type: input + id: vaadin-version + attributes: + label: Vaadin Version + description: The complete Vaadin version (X.Y.Z) on which the issue is reproducible. + validations: + required: true + - type: textarea + id: additional-information + attributes: + label: Additional information + description: "Any other context/information about the issue can be added here (browser, OS, etc.)." + validations: + required: false + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..4d37c3b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,24 @@ +name: Feature Request +description: Please add feature suggestions related to TEMPLATE_ADDON here. +body: + - type: textarea + id: feature-proposal + attributes: + label: Feature proposal + description: A concise but detailed description of the feature that you would like to see in the add-on. + validations: + required: true + - type: textarea + id: feature-implementation + attributes: + label: Describe solution expectations + description: Do you have an idea/expectations of how it could be implemented? Did you try a possible solution that you want to share? + validations: + required: false + - type: textarea + id: additional-information + attributes: + label: Additional information + description: Add any extra information you think it might be relevant to the request. + validations: + required: false diff --git a/.github/workflows/commits.yml b/.github/workflows/commits.yml new file mode 100644 index 0000000..d096e00 --- /dev/null +++ b/.github/workflows/commits.yml @@ -0,0 +1,8 @@ +name: Check Commits + +on: + pull_request: + +jobs: + check-commits: + uses: FlowingCode/GithubActions/.github/workflows/check-commits.yml@main diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml new file mode 100644 index 0000000..95c3fe2 --- /dev/null +++ b/.github/workflows/maven.yml @@ -0,0 +1,30 @@ +# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven + +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Java CI with Maven + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +jobs: + + build-vaadin24: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up JDK + uses: actions/setup-java@v3 + with: + java-version: '17' + distribution: 'temurin' + cache: maven + - name: Build (Vaadin 24) + run: mvn -B package --file pom.xml \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2201857 --- /dev/null +++ b/.gitignore @@ -0,0 +1,21 @@ +node_modules +target +.vscode +.settings +.project +.classpath +webpack.generated.js +package-lock.json +package.json +webpack.config.js +/error-screenshots +drivers +tsconfig.json +.idea +types.d.ts +vite.generated.ts +vite.config.ts +/src/main/dev-bundle +/src/main/bundles +/src/main/frontend/generated +/src/main/frontend/index.html \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..980a15a --- /dev/null +++ b/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/README.md b/README.md new file mode 100644 index 0000000..76d07e4 --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/template-addon) +[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/template-addon.svg)](https://vaadin.com/directory/component/template-addon) +[![Build Status](https://jenkins.flowingcode.com/job/template-addon/badge/icon)](https://jenkins.flowingcode.com/job/template-addon) +[![Maven Central](https://img.shields.io/maven-central/v/com.flowingcode.vaadin.addons/template-addon)](https://mvnrepository.com/artifact/com.flowingcode.vaadin.addons/template-addon) + +# Template Add-on + +This is a template project for building new Vaadin 24 add-ons + +## Features + +* List the features of your add-on in here + +## Online demo + +[Online demo here](http://addonsv24.flowingcode.com/template) + +## Download release + +[Available in Vaadin Directory](https://vaadin.com/directory/component/template-addon) + +### Maven install + +Add the following dependencies in your pom.xml file: + +```xml + + com.flowingcode.vaadin.addons + template-addon + X.Y.Z + +``` + + +Release versions are available from Maven Central repository. For SNAPSHOT versions see [here](https://maven.flowingcode.com/snapshots/). + +## Building and running demo + +- git clone repository +- mvn clean install jetty:run + +To see the demo, navigate to http://localhost:8080/ + +## Release notes + +See [here](https://github.com/FlowingCode/TemplateAddon/releases) + +## Issue tracking + +The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated. + +## Contributions + +Contributions are welcome, but there are no guarantees that they are accepted as such. + +As first step, please refer to our [Development Conventions](https://github.com/FlowingCode/DevelopmentConventions) page to find information about Conventional Commits & Code Style requirements. + +Then, follow these steps for creating a contribution: + +- Fork this project. +- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal. +- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue. +- For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change. +- Send a pull request for the original project. +- Comment on the original issue that you have implemented a fix for it. + +## License & Author + +This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt. + +TEMPLATE_ADDON is written by Flowing Code S.A. + +# Developer Guide + +## Getting started + +Add your code samples in this section + +## Special configuration when using Spring + +By default, Vaadin Flow only includes ```com/vaadin/flow/component``` to be always scanned for UI components and views. For this reason, the add-on might need to be allowed in order to display correctly. + +To do so, just add ```com.flowingcode``` to the ```vaadin.allowed-packages``` property in ```src/main/resources/application.properties```, like: + +```vaadin.allowed-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode``` + +More information on Spring scanning configuration [here](https://vaadin.com/docs/latest/integrations/spring/configuration/#configure-the-scanning-of-packages). diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..431cb5a --- /dev/null +++ b/pom.xml @@ -0,0 +1,500 @@ + + + 4.0.0 + + com.flowingcode.vaadin.addons + template-addon + 1.0.0-SNAPSHOT + Template Add-on + Template Add-on for Vaadin Flow + https://www.flowingcode.com/en/open-source/ + + + 24.4.6 + 4.10.0 + 17 + 17 + UTF-8 + UTF-8 + ${project.basedir}/drivers + 11.0.20 + 4.1.0 + true + + + + Flowing Code + https://www.flowingcode.com + + + 2024 + + + Apache 2 + http://www.apache.org/licenses/LICENSE-2.0.txt + repo + + + + + https://github.com/FlowingCode/AddonStarter24 + scm:git:git://github.com/FlowingCode/AddonStarter24.git + scm:git:ssh://git@github.com:/FlowingCode/AddonStarter24.git + master + + + + + ossrh + https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/ + + + + + + flowingcode + Flowing Code + https://www.flowingcode.com + + + + + + + com.vaadin + vaadin-bom + pom + import + ${vaadin.version} + + + + + + + central + https://repo.maven.apache.org/maven2 + + false + + + + Vaadin Directory + https://maven.vaadin.com/vaadin-addons + + + + Vaadin prereleases + https://maven.vaadin.com/vaadin-prereleases + + + + vaadin-snapshots + https://oss.sonatype.org/content/repositories/vaadin-snapshots/ + + + + + + central + https://repo.maven.apache.org/maven2 + + false + + + + + Vaadin prereleases + https://maven.vaadin.com/vaadin-prereleases + + + vaadin-snapshots + https://oss.sonatype.org/content/repositories/vaadin-snapshots/ + false + + + + + + com.vaadin + vaadin-core + true + + + com.flowingcode.vaadin.addons.demo + commons-demo + ${flowingcode.commons.demo.version} + + + org.slf4j + slf4j-simple + test + + + com.vaadin + vaadin-testbench + test + + + org.hamcrest + hamcrest-library + 1.3 + test + + + javax.servlet + javax.servlet-api + 3.1.0 + jar + test + + + io.github.bonigarcia + webdrivermanager + 5.9.1 + test + + + + + jetty:run + + + + org.apache.maven.plugins + maven-release-plugin + 3.0.1 + + @{project.version} + + + + org.apache.maven.plugins + maven-deploy-plugin + 2.8.2 + + + org.apache.maven.plugins + maven-surefire-plugin + 2.22.1 + + false + + + + + + + + org.apache.maven.plugins + maven-jar-plugin + 3.1.2 + + + true + + false + true + + + 1 + + + + + + maven-clean-plugin + 3.3.2 + + + + ${basedir} + + tsconfig.json + + + + + + + org.codehaus.mojo + license-maven-plugin + 2.3.0 + + apache_v2 + false + + **/dev-bundle/** + + + + + org.apache.maven.plugins + maven-surefire-plugin + + false + + + + com.vaadin + vaadin-maven-plugin + ${vaadin.version} + + + + prepare-frontend + + + + + + org.eclipse.jetty + jetty-maven-plugin + ${jetty.version} + + 3 + + true + + + src/test/resources/META-INF/resources + src/main/resources/META-INF/resources + + + + jar + + + + + + + + + directory + + + + org.apache.maven.plugins + maven-source-plugin + 3.0.1 + + + attach-sources + package + + jar-no-fork + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.0.1 + + + attach-javadocs + package + + jar + + + + + true + none + -Xdoclint:none + + + + org.apache.maven.plugins + maven-jar-plugin + 3.1.2 + + + + META-INF/VAADIN/config/flow-build-info.json + + + + + + + + + + production + + true + + + + com.vaadin + flow-server-production-mode + + + + + + + com.vaadin + vaadin-maven-plugin + + + + build-frontend + + + + + + + + + + integration-tests + + + + org.eclipse.jetty + jetty-maven-plugin + ${jetty.version} + + 0 + + jar + + ${project.artifactId} + 8081 + + + + start-jetty + pre-integration-test + + start + + + + stop-jetty + post-integration-test + + stop + + + + + + org.apache.maven.plugins + maven-failsafe-plugin + 2.22.2 + + + + integration-test + verify + + + + + false + true + + + + ${webdriver.chrome.driver} + + + + + + maven-resources-plugin + 3.1.0 + + + + copy-test-to-classes + process-test-classes + + copy-resources + + + ${project.build.outputDirectory} + + + ${project.build.testOutputDirectory} + + + + + + + + + + + + gpg + + + env.gpg.passphrase + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 3.1.0 + + + sign-artifacts + verify + + sign + + + ${env.gpg.passphrase} + + + + + + + + + + demo-jar + + + + org.apache.maven.plugins + maven-jar-plugin + + + + test-jar + + + demo + + **/test/* + **/it/* + **/DemoView.class + **/DemoLayout.class + + + + + + + + + + + + diff --git a/src/main/java/com/flowingcode/vaadin/addons/template/TemplateAddon.java b/src/main/java/com/flowingcode/vaadin/addons/template/TemplateAddon.java new file mode 100644 index 0000000..c9ec694 --- /dev/null +++ b/src/main/java/com/flowingcode/vaadin/addons/template/TemplateAddon.java @@ -0,0 +1,32 @@ +/*- + * #%L + * Template Add-on + * %% + * Copyright (C) 2024 Flowing Code + * %% + * 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. + * #L% + */ + +package com.flowingcode.vaadin.addons.template; + +import com.vaadin.flow.component.Tag; +import com.vaadin.flow.component.dependency.JsModule; +import com.vaadin.flow.component.dependency.NpmPackage; +import com.vaadin.flow.component.html.Div; + +@SuppressWarnings("serial") +@NpmPackage(value = "@polymer/paper-input", version = "3.2.1") +@JsModule("@polymer/paper-input/paper-input.js") +@Tag("paper-input") +public class TemplateAddon extends Div {} diff --git a/src/main/resources/META-INF/frontend/styles/static_addon_styles b/src/main/resources/META-INF/frontend/styles/static_addon_styles new file mode 100644 index 0000000..c2a6ed1 --- /dev/null +++ b/src/main/resources/META-INF/frontend/styles/static_addon_styles @@ -0,0 +1 @@ +Place add-on shareable styles in this folder \ No newline at end of file diff --git a/src/main/resources/META-INF/resources/static_addon_resources b/src/main/resources/META-INF/resources/static_addon_resources new file mode 100644 index 0000000..70832cc --- /dev/null +++ b/src/main/resources/META-INF/resources/static_addon_resources @@ -0,0 +1 @@ +Place static add-on resources in this folder \ No newline at end of file diff --git a/src/test/java/com/flowingcode/vaadin/addons/DemoLayout.java b/src/test/java/com/flowingcode/vaadin/addons/DemoLayout.java new file mode 100644 index 0000000..b84172e --- /dev/null +++ b/src/test/java/com/flowingcode/vaadin/addons/DemoLayout.java @@ -0,0 +1,31 @@ +/*- + * #%L + * Template Add-on + * %% + * Copyright (C) 2024 Flowing Code + * %% + * 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. + * #L% + */ +package com.flowingcode.vaadin.addons; + +import com.vaadin.flow.component.html.Div; +import com.vaadin.flow.router.RouterLayout; + +@SuppressWarnings("serial") +public class DemoLayout extends Div implements RouterLayout { + + public DemoLayout() { + setSizeFull(); + } +} diff --git a/src/test/java/com/flowingcode/vaadin/addons/template/DemoView.java b/src/test/java/com/flowingcode/vaadin/addons/template/DemoView.java new file mode 100644 index 0000000..a600c9d --- /dev/null +++ b/src/test/java/com/flowingcode/vaadin/addons/template/DemoView.java @@ -0,0 +1,36 @@ +/*- + * #%L + * Template Add-on + * %% + * Copyright (C) 2024 Flowing Code + * %% + * 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. + * #L% + */ + +package com.flowingcode.vaadin.addons.template; + +import com.vaadin.flow.component.orderedlayout.VerticalLayout; +import com.vaadin.flow.router.BeforeEnterEvent; +import com.vaadin.flow.router.BeforeEnterObserver; +import com.vaadin.flow.router.Route; + +@SuppressWarnings("serial") +@Route("") +public class DemoView extends VerticalLayout implements BeforeEnterObserver { + + @Override + public void beforeEnter(BeforeEnterEvent event) { + event.forwardTo(TemplateDemoView.class); + } +} diff --git a/src/test/java/com/flowingcode/vaadin/addons/template/TemplateDemo.java b/src/test/java/com/flowingcode/vaadin/addons/template/TemplateDemo.java new file mode 100644 index 0000000..5f6e6ee --- /dev/null +++ b/src/test/java/com/flowingcode/vaadin/addons/template/TemplateDemo.java @@ -0,0 +1,17 @@ +package com.flowingcode.vaadin.addons.template; + +import com.flowingcode.vaadin.addons.demo.DemoSource; +import com.vaadin.flow.component.html.Div; +import com.vaadin.flow.router.PageTitle; +import com.vaadin.flow.router.Route; + +@DemoSource +@PageTitle("Template Add-on Demo") +@SuppressWarnings("serial") +@Route(value = "demo", layout = TemplateDemoView.class) +public class TemplateDemo extends Div { + + public TemplateDemo() { + add(new TemplateAddon()); + } +} diff --git a/src/test/java/com/flowingcode/vaadin/addons/template/TemplateDemoView.java b/src/test/java/com/flowingcode/vaadin/addons/template/TemplateDemoView.java new file mode 100644 index 0000000..1954535 --- /dev/null +++ b/src/test/java/com/flowingcode/vaadin/addons/template/TemplateDemoView.java @@ -0,0 +1,38 @@ +/*- + * #%L + * Template Add-on + * %% + * Copyright (C) 2024 Flowing Code + * %% + * 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. + * #L% + */ +package com.flowingcode.vaadin.addons.template; + +import com.flowingcode.vaadin.addons.DemoLayout; +import com.flowingcode.vaadin.addons.GithubLink; +import com.flowingcode.vaadin.addons.demo.TabbedDemo; +import com.vaadin.flow.router.ParentLayout; +import com.vaadin.flow.router.Route; + +@SuppressWarnings("serial") +@ParentLayout(DemoLayout.class) +@Route("template") +@GithubLink("https://github.com/FlowingCode/AddonStarter24") +public class TemplateDemoView extends TabbedDemo { + + public TemplateDemoView() { + addDemo(TemplateDemo.class); + setSizeFull(); + } +} diff --git a/src/test/java/com/flowingcode/vaadin/addons/template/it/AbstractViewTest.java b/src/test/java/com/flowingcode/vaadin/addons/template/it/AbstractViewTest.java new file mode 100644 index 0000000..1f7749b --- /dev/null +++ b/src/test/java/com/flowingcode/vaadin/addons/template/it/AbstractViewTest.java @@ -0,0 +1,106 @@ +/*- + * #%L + * Template Add-on + * %% + * Copyright (C) 2024 Flowing Code + * %% + * 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. + * #L% + */ + +package com.flowingcode.vaadin.addons.template.it; + +import com.vaadin.testbench.ScreenshotOnFailureRule; +import com.vaadin.testbench.TestBench; +import com.vaadin.testbench.parallel.ParallelTest; +import io.github.bonigarcia.wdm.WebDriverManager; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Rule; +import org.openqa.selenium.chrome.ChromeDriver; + +/** + * Base class for ITs + * + *

The tests use Chrome driver (see pom.xml for integration-tests profile) to run integration + * tests on a headless Chrome. If a property {@code test.use .hub} is set to true, {@code + * AbstractViewTest} will assume that the TestBench test is running in a CI environment. In order to + * keep the this class light, it makes certain assumptions about the CI environment (such as + * available environment variables). It is not advisable to use this class as a base class for you + * own TestBench tests. + * + *

To learn more about TestBench, visit Vaadin TestBench. + */ +public abstract class AbstractViewTest extends ParallelTest { + private static final int SERVER_PORT = 8080; + + private final String route; + + @Rule public ScreenshotOnFailureRule rule = new ScreenshotOnFailureRule(this, true); + + public AbstractViewTest() { + this(""); + } + + protected AbstractViewTest(String route) { + this.route = route; + } + + @BeforeClass + public static void setupClass() { + WebDriverManager.chromedriver().setup(); + } + + @Override + @Before + public void setup() throws Exception { + if (isUsingHub()) { + super.setup(); + } else { + setDriver(TestBench.createDriver(new ChromeDriver())); + } + getDriver().get(getURL(route)); + } + + /** + * Returns deployment host name concatenated with route. + * + * @return URL to route + */ + private static String getURL(String route) { + return String.format("http://%s:%d/%s", getDeploymentHostname(), SERVER_PORT, route); + } + + /** Property set to true when running on a test hub. */ + private static final String USE_HUB_PROPERTY = "test.use.hub"; + + /** + * Returns whether we are using a test hub. This means that the starter is running tests in + * Vaadin's CI environment, and uses TestBench to connect to the testing hub. + * + * @return whether we are using a test hub + */ + private static boolean isUsingHub() { + return Boolean.TRUE.toString().equals(System.getProperty(USE_HUB_PROPERTY)); + } + + /** + * If running on CI, get the host name from environment variable HOSTNAME + * + * @return the host name + */ + private static String getDeploymentHostname() { + return isUsingHub() ? System.getenv("HOSTNAME") : "localhost"; + } +} diff --git a/src/test/java/com/flowingcode/vaadin/addons/template/it/ViewIT.java b/src/test/java/com/flowingcode/vaadin/addons/template/it/ViewIT.java new file mode 100644 index 0000000..0e5f164 --- /dev/null +++ b/src/test/java/com/flowingcode/vaadin/addons/template/it/ViewIT.java @@ -0,0 +1,64 @@ +/*- + * #%L + * Template Add-on + * %% + * Copyright (C) 2024 Flowing Code + * %% + * 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. + * #L% + */ + +package com.flowingcode.vaadin.addons.template.it; + +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.not; +import static org.junit.Assert.assertThat; + +import com.vaadin.testbench.TestBenchElement; +import org.hamcrest.Description; +import org.hamcrest.Matcher; +import org.hamcrest.TypeSafeDiagnosingMatcher; +import org.junit.Test; + +public class ViewIT extends AbstractViewTest { + + private Matcher hasBeenUpgradedToCustomElement = + new TypeSafeDiagnosingMatcher() { + + @Override + public void describeTo(Description description) { + description.appendText("a custom element"); + } + + @Override + protected boolean matchesSafely(TestBenchElement item, Description mismatchDescription) { + String script = "let s=arguments[0].shadowRoot; return !!(s&&s.childElementCount)"; + if (!item.getTagName().contains("-")) { + return true; + } + if ((Boolean) item.getCommandExecutor().executeScript(script, item)) { + return true; + } else { + mismatchDescription.appendText(item.getTagName() + " "); + mismatchDescription.appendDescriptionOf(is(not(this))); + return false; + } + } + }; + + @Test + public void componentWorks() { + TestBenchElement element = $("paper-input").first(); + assertThat(element, hasBeenUpgradedToCustomElement); + } +} diff --git a/src/test/java/com/flowingcode/vaadin/addons/template/test/SerializationTest.java b/src/test/java/com/flowingcode/vaadin/addons/template/test/SerializationTest.java new file mode 100644 index 0000000..1ee78c3 --- /dev/null +++ b/src/test/java/com/flowingcode/vaadin/addons/template/test/SerializationTest.java @@ -0,0 +1,52 @@ +/*- + * #%L + * Template Add-on + * %% + * Copyright (C) 2024 Flowing Code + * %% + * 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. + * #L% + */ +package com.flowingcode.vaadin.addons.template.test; + +import com.flowingcode.vaadin.addons.template.TemplateAddon; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.ObjectInputStream; +import java.io.ObjectOutputStream; +import org.junit.Assert; +import org.junit.Test; + +public class SerializationTest { + + private void testSerializationOf(Object obj) throws IOException, ClassNotFoundException { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + try (ObjectOutputStream oos = new ObjectOutputStream(baos)) { + oos.writeObject(obj); + } + try (ObjectInputStream in = + new ObjectInputStream(new ByteArrayInputStream(baos.toByteArray()))) { + obj.getClass().cast(in.readObject()); + } + } + + @Test + public void testSerialization() throws ClassNotFoundException, IOException { + try { + testSerializationOf(new TemplateAddon()); + } catch (Exception e) { + Assert.fail("Problem while testing serialization: " + e.getMessage()); + } + } +} diff --git a/src/test/resources/META-INF/frontend/styles/shared-styles.css b/src/test/resources/META-INF/frontend/styles/shared-styles.css new file mode 100644 index 0000000..6680e2d --- /dev/null +++ b/src/test/resources/META-INF/frontend/styles/shared-styles.css @@ -0,0 +1 @@ +/*Demo styles*/ \ No newline at end of file diff --git a/src/test/resources/META-INF/resources/static_addon_test_resources b/src/test/resources/META-INF/resources/static_addon_test_resources new file mode 100644 index 0000000..b68f527 --- /dev/null +++ b/src/test/resources/META-INF/resources/static_addon_test_resources @@ -0,0 +1 @@ +Place static addon test resources in this folder \ No newline at end of file