Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TCK documentation #1644

Merged
merged 2 commits into from
Mar 17, 2022
Merged

TCK documentation #1644

merged 2 commits into from
Mar 17, 2022

Conversation

alwin-joseph
Copy link
Contributor

@alwin-joseph alwin-joseph commented Mar 15, 2022

This PR is an attempt to create a new userguide/documentation for the new Faces TCK. This can act as little more than a skeleton for the final userguide and other documentation.

To generate userguide documents:

cd tck/docs/userguide
mvn

This will generate pdf userguide at docs/userguide/target/generated-docs/Jakarta-Server-Faces-TCK-Users-Guide.pdf and html userguide at docs/userguide/target/staging/

What this PR covers :

  1. The old style TCK userguide at https://github.com/eclipse-ee4j/jakartaee-tck/tree/master/user_guides/jsf is migrated along with major updates required to conform with the new TCK created in this repo.
  2. The assertion files from https://github.com/eclipse-ee4j/jakartaee-tck/tree/master/install/jsf/docs and https://github.com/eclipse-ee4j/jakartaee-tck/tree/master/internal/docs/jsf were also migrated.

What is not covered in this PR:

  1. The contents of the userguide need to be closely reviewed by the spec team for correctness and more changes will need to be added preferably in a separate PR. Especially the installation and steps required to run the tests need to be looked into.
  2. The docs folder (and faces-signaturetest) need to be integrated with the main pom to be part of the final tck bundle.
  3. The new Javadoc assertion files added as faces/tck/docs/assertions/javadoc/JakartaFacesJavadocAssertions_4.0.html and faces/tck/docs/assertions/javadoc/JakartaFacesJavadocAssertions_4.0.xml will need to be reviewed and corrections need to be made if any.
  4. New Spec assertions file for this release (4.0) is not created. They will have to be created by adding new assertions to the old spec assertion document after going through the spec document (manual effort).

NB: If there is a different effort already happening to create a fresh documentation or if this userguide/assertions from the old style TCK does not seem necessary, I think this PR can be discarded.

@arjantijms @BalusC

@alwin-joseph alwin-joseph mentioned this pull request Mar 15, 2022
12 tasks
@arjantijms
Copy link
Contributor

Thanks! This looks good. I'll look at some examples to run the TCK for a server that does not currently have a profile in the main pom.xml. The Jakarta REST TCK does this by having the entire TCK as "test-jar" dependency in a new Maven project. We can't do that for Faces, as we have a multi-module structure for the tests. AFAIK, the Jakarta REST TCK approach (also used by e.g. MicroProfile JWT) only works if you have one monolithic test jar.

Example of running MP JWT TCK: https://github.com/piranhacloud/piranha/blob/current/external/tck/jwt/pom.xml

@arjantijms arjantijms merged commit 1236c58 into jakartaee:master Mar 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants