Skip to content

Commit

Permalink
Merge pull request #3837 from OpenLiberty/docs_accessibility
Browse files Browse the repository at this point in the history 
Docs accessibility
  • Loading branch information
@SteveSamJacob19
SteveSamJacob19 authored Aug 21, 2024
2 parents a18750b + 91f40e8 commit 0a01a88
Show file tree
Hide file tree
Showing 7 changed files with 142 additions and 3 deletions.
5 changes: 5 additions & 0 deletions src/test/cypressjs/cypress.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,10 @@ module.exports = defineConfig({
supportFile: '/__w/openliberty.io/openliberty.io/src/test/cypressjs/cypress/support/e2e.js',
specPattern: '/__w/openliberty.io/openliberty.io/src/test/cypressjs/cypress/e2e/*.cy.js',
downloadsFolder: '__w/openliberty.io/openliberty.io/src/test/cypressjs/cypress/downloads',
setupNodeEvents(on, config) {
on('task', {
accessibilityChecker: require('cypress-accessibility-checker/plugin')
});
}
},
})
56 changes: 56 additions & 0 deletions src/test/cypressjs/cypress/docs_samples/ol_api_samples.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
export const samples=[
{
section:'Overview',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/oauth-2.0.com.ibm.oauth.core.api.attributes.html?path=24.0.0.3/com.ibm.websphere.appserver.api.oauth_1.2-javadoc/index.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/api/servlet-5.0.com.ibm.websphere.servlet.container.html?path=24.0.0.5/io.openliberty.servlet_1.1-javadoc/index.html',
},
{
section:'Packages',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/distributedMap-1.0.com.ibm.wsspi.cache.html?path=24.0.0.3/com.ibm.websphere.appserver.api.distributedMap_2.0-javadoc/com/ibm/wsspi/cache/package-summary.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/api/j2eeManagement-1.1.com.ibm.websphere.management.j2ee.html?path=24.0.0.3/com.ibm.websphere.appserver.api.j2eemanagement_1.1-javadoc/com/ibm/websphere/management/j2ee/package-summary.html',
},
{
section:'Deprecated',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/distributedMap-1.0.com.ibm.wsspi.cache.html?path=24.0.0.3/com.ibm.websphere.appserver.api.distributedMap_2.0-javadoc/deprecated-list.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/api/servlet-5.0.com.ibm.websphere.servlet.container.html?path=24.0.0.3/io.openliberty.servlet_1.1-javadoc/deprecated-list.html',
},
{
section:'Help',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/distributedMap-1.0.com.ibm.wsspi.cache.html?path=24.0.0.3/com.ibm.websphere.appserver.api.distributedMap_2.0-javadoc/help-doc.html#package',
url2:'https://openliberty.io/docs/latest/reference/javadoc/api/appSecurity-2.0.com.ibm.wsspi.security.auth.callback.html?path=24.0.0.3/com.ibm.websphere.appserver.api.security_1.3-javadoc/help-doc.html#package',
},
{
section:'Tree',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/oauth-2.0.com.ibm.oauth.core.api.attributes.html?path=24.0.0.3/com.ibm.websphere.appserver.api.oauth_1.2-javadoc/overview-tree.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/api/distributedMap-1.0.com.ibm.wsspi.cache.html?path=24.0.0.3/com.ibm.websphere.appserver.api.distributedMap_2.0-javadoc/com/ibm/wsspi/cache/package-tree.html',
},
{
section:'Class',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/distributedMap-1.0.com.ibm.wsspi.cache.html?path=24.0.0.3/com.ibm.websphere.appserver.api.distributedMap_2.0-javadoc/com/ibm/wsspi/cache/Cache.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/api/j2eeManagement-1.1.com.ibm.websphere.management.j2ee.html?path=24.0.0.3/com.ibm.websphere.appserver.api.j2eemanagement_1.1-javadoc/com/ibm/websphere/management/j2ee/J2EEManagementObjectNameFactory.html',
},
{
section:'Interface',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/appSecurityClient-1.0.com.ibm.websphere.security.html?path=24.0.0.3/com.ibm.websphere.appserver.api.securityClient_1.1-javadoc/com/ibm/websphere/security/UserRegistry.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/api/restConnector-2.0.com.ibm.websphere.jmx.connector.rest.html?path=24.0.0.3/com.ibm.websphere.appserver.api.restConnector_1.3-javadoc/com/ibm/websphere/jmx/connector/rest/ConnectorSettings.html',
},
{
section:'Exception',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/appSecurityClient-1.0.com.ibm.websphere.security.html?path=24.0.0.3/com.ibm.websphere.appserver.api.securityClient_1.1-javadoc/com/ibm/websphere/security/WSSecurityException.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/api/appSecurityClient-1.0.com.ibm.websphere.security.html?path=24.0.0.3/com.ibm.websphere.appserver.api.securityClient_1.1-javadoc/com/ibm/websphere/security/CertificateMapFailedException.html',
},
{
section:'Annotation',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/grpc-1.0.io.openliberty.grpc.annotation.html?path=24.0.0.3/io.openliberty.grpc.1.0_1.0-javadoc/io/openliberty/grpc/annotation/GrpcService.html',
},
{
section:'Enum',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/j2eeManagement-1.1.com.ibm.websphere.management.j2ee.html?path=24.0.0.3/com.ibm.websphere.appserver.api.j2eemanagement_1.1-javadoc/com/ibm/websphere/management/j2ee/J2EEManagementObjectNameFactory.ResourceType.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/api/distributedMap-1.0.com.ibm.wsspi.cache.html?path=24.0.0.3/com.ibm.websphere.appserver.api.distributedMap_2.0-javadoc/com/ibm/wsspi/cache/CacheConfig.EvictorAlgorithmType.html',
},
{
section:'Use',
url1:'https://openliberty.io/docs/latest/reference/javadoc/api/distributedMap-1.0.com.ibm.wsspi.cache.html?path=24.0.0.3/com.ibm.websphere.appserver.api.distributedMap_2.0-javadoc/com/ibm/wsspi/cache/package-use.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/api/distributedMap-1.0.com.ibm.wsspi.cache.html?path=24.0.0.3/com.ibm.websphere.appserver.api.distributedMap_2.0-javadoc/com/ibm/wsspi/cache/class-use/CacheConfig.EvictorAlgorithmType.html',
},
]
47 changes: 47 additions & 0 deletions src/test/cypressjs/cypress/docs_samples/ol_spi_samples.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
export const samples=[
{
section:'Overview',
url1:'https://openliberty.io/docs/latest/reference/javadoc/spi/appClientSupport-1.0.com.ibm.ws.adaptable.module.structure.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.artifact_1.2-javadoc/index.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/spi/ejbLite-3.2.com.ibm.ws.adaptable.module.structure.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.artifact_1.2-javadoc/index.html',
},
{
section:'Packages',
url1:'https://openliberty.io/docs/latest/reference/javadoc/spi/appClientSupport-1.0.com.ibm.wsspi.adaptable.module.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.artifact_1.2-javadoc/com/ibm/wsspi/adaptable/module/package-summary.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/spi/ejbLite-3.2.com.ibm.wsspi.anno.classsource.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.anno_1.1-javadoc/com/ibm/wsspi/anno/classsource/package-summary.html',
},
{
section:'Deprecated',
url1:'https://openliberty.io/docs/latest/reference/javadoc/spi/appClientSupport-1.0.com.ibm.ws.adaptable.module.structure.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.artifact_1.2-javadoc/deprecated-list.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/spi/ejbLite-3.2.com.ibm.ws.adaptable.module.structure.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.artifact_1.2-javadoc/deprecated-list.html',
},
{
section:'Help',
url1:'https://openliberty.io/docs/latest/reference/javadoc/spi/appClientSupport-1.0.com.ibm.wsspi.adaptable.module.adapters.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.artifact_1.2-javadoc/help-doc.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/spi/ejbLite-3.2.com.ibm.ws.adaptable.module.structure.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.artifact_1.2-javadoc/help-doc.html',
},
{
section:'Tree',
url1:'https://openliberty.io/docs/latest/reference/javadoc/spi/appClientSupport-1.0.com.ibm.ws.adaptable.module.structure.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.artifact_1.2-javadoc/overview-tree.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/spi/ejbLite-3.2.com.ibm.wsspi.anno.classsource.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.anno_1.1-javadoc/com/ibm/wsspi/anno/classsource/package-tree.html',
},
{
section:'Class',
url1:'https://openliberty.io/docs/latest/reference/javadoc/spi/appClientSupport-1.0.com.ibm.wsspi.adaptable.module.html?path=24.0.0.5/com.ibm.websphere.appserver.spi.artifact_1.2-javadoc/com/ibm/wsspi/adaptable/module/DefaultNotification.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/spi/ejbLite-3.2.com.ibm.wsspi.artifact.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.artifact_1.2-javadoc/com/ibm/wsspi/artifact/DefaultArtifactNotification.html',
},
{
section:'Interface',
url1:'https://openliberty.io/docs/latest/reference/javadoc/spi/appClientSupport-1.0.com.ibm.ws.anno.classsource.specification.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.anno_1.1-javadoc/com/ibm/ws/anno/classsource/specification/ClassSource_Specification_Container.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/spi/ejbLite-3.2.com.ibm.wsspi.anno.classsource.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.anno_1.1-javadoc/com/ibm/wsspi/anno/classsource/ClassSource.html',
},
{
section:'Exception',
url1:'https://openliberty.io/docs/latest/reference/javadoc/spi/appClientSupport-1.0.com.ibm.wsspi.anno.classsource.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.anno_1.1-javadoc/com/ibm/wsspi/anno/classsource/ClassSource_Exception.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/spi/ejbLite-3.2.com.ibm.wsspi.anno.targets.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.anno_1.1-javadoc/com/ibm/wsspi/anno/targets/AnnotationTargets_Exception.html',
},
{
section:'Enum',
url1:'https://openliberty.io/docs/latest/reference/javadoc/spi/appClientSupport-1.0.com.ibm.wsspi.anno.classsource.html?path=24.0.0.5/com.ibm.websphere.appserver.spi.anno_1.1-javadoc/com/ibm/wsspi/anno/classsource/ClassSource_ScanCounts.ResultField.html',
url2:'https://openliberty.io/docs/latest/reference/javadoc/spi/ejbLite-3.2.com.ibm.wsspi.anno.util.html?path=24.0.0.3/com.ibm.websphere.appserver.spi.anno_1.1-javadoc/com/ibm/wsspi/anno/util/Util_InternMap.ValueType.html',
},
]
13 changes: 13 additions & 0 deletions src/test/cypressjs/cypress/e2e/ol_api.cy.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import {samples} from "../docs_samples/ol_api_samples";
describe('Openliberty API Accesibility Tests', () => {
samples.forEach((sample)=>{
it(`Testing ${sample.section}`,()=>{
cy.visit(sample.url1);
cy.getCompliance(`./OL_API/ol_api_${sample.section.toLowerCase()}1`);
if(sample.url2){
cy.visit(sample.url2);
cy.getCompliance(`./OL_API/ol_api_${sample.section.toLowerCase()}2`);
}
})
})
})
13 changes: 13 additions & 0 deletions src/test/cypressjs/cypress/e2e/ol_spi.cy.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import {samples} from "../docs_samples/ol_spi_samples";
describe('Openliberty SPI Accesibility Tests', () => {
samples.forEach((sample)=>{
it(`Testing ${sample.section}`,()=>{
cy.visit(sample.url1);
cy.getCompliance(`./OL_SPI/ol_spi_${sample.section.toLowerCase()}1`);
if(sample.url2){
cy.visit(sample.url2);
cy.getCompliance(`./OL_SPI/ol_spi_${sample.section.toLowerCase()}2`);
}
})
})
})
3 changes: 2 additions & 1 deletion src/test/cypressjs/cypress/support/e2e.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@
// ***********************************************************

// Import commands.js using ES2015 syntax:
import './commands'
import './commands';
import 'cypress-accessibility-checker';
8 changes: 6 additions & 2 deletions src/test/cypressjs/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{
"devDependencies": {
"cypress": "^13.11.0",
"cypress-accessibility-checker": "^3.1.71"
},
"dependencies": {
"cypress": "^12.12.0"
"axios": "^1.7.2"
}
}
}

0 comments on commit 0a01a88

Please sign in to comment.