primefaces-extensions / primefaces-arquillian Goto Github PK

View Code? Open in Web Editor NEW

16.0 16.0 4.0 131 KB

PrimeFaces testing support for Arquillian

License: Apache License 2.0

Java 98.68% HTML 1.32%

primefaces-arquillian's Introduction

PrimeFaces Extensions

This is an overview page, please visit primefaces-extensions.github.io or the showcase for more information.

Versioning

There are multiple versions available please check which one for your PrimeFaces release version.

Version	Explanation
	PrimeFaces 8.0
	PrimeFaces 10.0.0
	PrimeFaces 11.0.0
	PrimeFaces 12.0.0
	PrimeFaces 13.0.0
	PrimeFaces 14.0.0

Maven

Release (javax)

<dependency>
    <groupId>org.primefaces.extensions</groupId>
    <artifactId>primefaces-extensions</artifactId>
    <version>${primefaces-extensions.version}</version>
</dependency>
<dependency>
   <groupId>org.primefaces.extensions</groupId>
   <artifactId>resources-monacoeditor</artifactId>
   <version>${primefaces-extensions.version}</version>
</dependency>

Release (jakarta)

<dependency>
    <groupId>org.primefaces.extensions</groupId>
    <artifactId>primefaces-extensions</artifactId>
    <version>${primefaces-extensions.version}</version>
    <classifier>jakarta</classifier>
</dependency>

Snapshots

<repository>
    <id>sonatype-snapshots</id>
    <name>Sonatype Snapshot Repository</name>
    <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
    <releases>
        <enabled>false</enabled>
    </releases>
    <snapshots>
        <enabled>true</enabled>
    </snapshots>
</repository>

<dependency>
   <groupId>org.primefaces.extensions</groupId>
   <artifactId>primefaces-extensions</artifactId>
   <version>${primefaces-extensions.version}</version>
</dependency>

Namespaces

The PrimeFaces Extensions namespace is necessary to add PrimeFaces Extensions components to your pages.

xmlns:pe="http://primefaces.org/ui/extensions"

Getting Started

Please refer to the Getting Started Guide to see what you need to get started and any optional libraries.

Migration Guide

Please refer to the Migration Guide.

Demo

Please refer to the Showcase submodule in order to see the full usage of the components. Simply do the following to run the Showcase:

cd showcase
mvn clean jetty:run

Then open your web browser to http://localhost:8080/showcase-ext/

Issues

Please report all issues here.

Releasing

Run mvn versions:set -DgenerateBackupPoms=false -DnewVersion=8.0.2 to update all modules versions
Commit and push the changes to GitHub
In GitHub create a new Release titled 8.0.2 to tag this release
Run mvn clean deploy -Prelease to push to Maven Central

License

Licensed under the MIT license.

SPDX-License-Identifier: MIT

primefaces-arquillian's People

Contributors

Stargazers

Watchers

Forkers

rmpestano 1placenz ravihariharan rodrigoieh

primefaces-arquillian's Issues

Introduce first test, to test PrimeFaces components

@rmpestano @krichter722
Are you interessted in doing this?
I would add an new project "primefaces-arquillian-tests", which uses primefaces-arquillian, to test components

I got a nice testcase today, which is pretty easy:
primefaces/primefaces#4009

click on the button
check if modal div is below the document.body

i think it's quite easy but requires to setup the project + adding a dialog component to primefaces-arquillian

Dicuss versioning

@rmpestano @krichter722 @melloware
Which version number pattern should we use?

I thought about reusing the primefaces version + append our release version.

So the first release, based on 6.2 would be: 6.2.1
The second release for 6.2 would be: 6.2.2

The first release based on 6.3 would be: 6.3.1

Current master would be 6.2.1-SNAPSHOT then

Example: Download webdriver automactly

Currently the project uses fixed path for chrome driver binary:

ERROR] myFirstTest(org.primefaces.extensions.arquillian.example.IndexPageTest)  Time elapsed: 0.049 s  <<< ERROR!
java.lang.IllegalArgumentException: The file D:/chromedriver.exe does not exist

The binary can be downloaded by drone, see docs here.

Example: Build the test archive (.war) during test

Currently this project relies on an already builded war file on target folder (see here). This may cause issues specially when you run the test from the IDE, e.g you updated the project and forget to build it then your tests will run on top of old code.

A more automatic approach is to build the binary on the deployment method, see an example here, also a blog post about it here.

I can contribute if you agree.

Example: Make tests run on Travisci

For ftests on travisci we can use chrome on headless mode or using Sauce labs, see travis docs here.

The advantage of Sauce labs is that the test runs on a real browser. On the other hand chrome headless setup is much simpler.

I have experience with chrome in headless mode and could provide a PR if you decide to use it.

Activate Travis CI for the project

The .travis.yml has been merged, however it has no effect because commits and PRs are not checked as long as the project isn't activated. You can do that on https://www.travis-ci.org/primefaces-extensions/primefaces-arquillian.

dependent: #6

Provide Maven Javadoc and source artifacts

Maven Javadoc and source artifacts allow it to gain quick and uncomplicated access to the documentation in almost all modern IDE and to take a look at an implementation detail in case suspicion about correct implementation arises.

The deployment of the Javadoc and sources artifact should be included in the CI/CD processes. I don't know how they work in PrimeFaces or PrimeFaces extensions. I could suggest a PR, but it'd only be the addition of the maven-javadoc-plugin and maven-sources-plugin without me knowing whether that does the trick.