Skip to content

Compatibility_Certification_Request_CCR_Review_Guidance

Jump to bottom
Ed Burns edited this page Dec 6, 2022 · 6 revisions

Instructions to review Compatibility Certification Requests (CCRs) (Note: this is Work in Progress)

  1. Find the list of open CCRs by querying for issues with the label certification. Query link
  2. Review the contents of the CCR
    1. Verify that all links resolve to expected pages.
    2. Verify the product version of the CCR matches the version on the vendor page.
    3. Verify the TCK zip download link points to the corresponding official TCK. The base URL must be https://download.eclipse.org/jakartaee/ [*].
    4. TCKs and their SHA-256 hash verification
      • Verify that the SHA-256 hash matches the sum that is provided for this TCK version on the component specification page.
      • Verify that all required dependent TCKs are also referenced [**]
      • Verify that all required dependent TCKs SHA hash codes are correct.
    5. Verify that the final two check-boxes are checked (the CCR cannot be accepted if these items are not checked).
  3. Validate the TCK Results Summary web page
    1. Verify the Public URL of TCK Results Summary is a valid link and does not require a login.
    2. The TCK Summary must be on a site that is associated with the product (i.e. it should not be a Specification page). The summary should be a page that is permanent (i.e. it should not be a volatile CI/CD build result page unless you can verify that the page has been saved in some way).
    3. Verify the required documentation is copied to the TCK Summary page (generally, the same detail included in the CCR issue).
    4. Verify all required TCKs are referenced
    5. Verify the SHA hash codes match with the CCR Issue
    6. Verify that all tests are reported to pass. There should be no failures (some test configurations may result in skipped tests). The number of tests may vary from vendor to vendor.
  4. If you have any comments or questions for the filer, make them in the Issue comments.
  5. Once everything checks out to your satisfaction, make an entry in the Issue comments, indicating the issue is ready for approval (e.g. LGTM, Recommend for approval).
  6. Assign the issue to one of the current project leads (you can find the leads for the Jakarta EE Platform project, here).
  7. A vendor may drop a note in e-mail to the Platform Committer mailing list, requesting action. Be sure to use a clear subject (e.g. Please Approve Certification Request #NNN)
  8. How does a CCR become approved?
    1. For CCRs against Final specifications, if no action is taken, after two weeks, the certification is deemed approved, by "Lazy Consensus."
    2. For CCRs against Proposed Final specifications, if the reviewer has given the LGTM, a committer for the specification adds the approved-pending-ballot label. After the specification release ballot concludes, remove the approved-pending-ballot label and add the accepted label.

More information can be found in Jakarta EE TCK Process Guide, in the section "Filing a Certification Request" If you have any additional questions, send an e-mail to the Jakarta EE Platform Dev team mailing list.

* In some cases (prior to release ballot) the TCK link may not have a base URL that matches. In these special cases, the SHA hash may be used to validate that the TCK used for certification matches the SHA hash of the TCK that will be accepted to the download-center, after the release ballot is approved. In this case the SHA hash may be found in the Pull Request conversation, for the Specification Page update (e.g. a PR against the Specifications GitHub repository). Most likely you will know that you are working with a pre-final TCK and CCR. If you have any questions, contact the developer team mailing list.

** How do I know what additional TCKs are required for each Platform Specification?

  • For Core Profile, refer to the "Technology Compatibility Kit Reference Guide for Jakarta Core Profile". This document is included in the Core Profile TCK zip file. Find the section that contains text similar to each Product must pass the following standalone TCKs or the string CORE_PROFILE-10.
  • For Web Profile and Jakarta EE Platform (aka "full profile"), refer to the "Jakarta EE Platform, Enterprise Edition N Test Compatibility Kit User’s Guide, Release N for Jakarta EE", where N is the release number, such as 10. This document is included in the Jakarta EE TCK zip file.
    • For Web Profile, find the section that contains the string EE-WP21.
    • For Jakarta EE Platform (aka "full profile"), find the section that contains the string EE21.
Clone this wiki locally