|
| 1 | +import { VALIDATED_LINKS } from '../data/validatedLinks'; |
| 2 | +import { REQUEST_GET_LINKS } from '../data/requestGetLinks'; |
| 3 | +import { BASE_URL } from '../data/constants'; |
| 4 | +import 'cypress-each'; |
| 5 | + |
| 6 | +type EvtName = |
| 7 | + | 'CHECKING' |
| 8 | + | 'SKIPPING_SITEMAP' |
| 9 | + | 'SKIPPING_VALIDATED' |
| 10 | + | 'REQUESTING' |
| 11 | + | 'RETURNING' |
| 12 | + | 'NO_HREF'; |
| 13 | +let allLinks: string[] = []; |
| 14 | +const numberOfLinks = 119; |
| 15 | +const requestedLinks: Set<string> = new Set(); |
| 16 | + |
| 17 | +before(() => { |
| 18 | + cy.task('readSitemapLinks').then((links: string[]) => { |
| 19 | + allLinks = allLinks.concat(links); |
| 20 | + }); |
| 21 | +}); |
| 22 | + |
| 23 | +describe('Local Sitemap', () => { |
| 24 | + it('should have 119 links', () => { |
| 25 | + expect(allLinks.length).to.eq(numberOfLinks); |
| 26 | + }); |
| 27 | +}); |
| 28 | + |
| 29 | +describe(`All pages on Sitemap`, () => { |
| 30 | + it.each(numberOfLinks)('all links on page %k should work', (i: string) => { |
| 31 | + const link = allLinks[i]; |
| 32 | + cy.task('log', `🧪[TESTING...] page ${BASE_URL}/${link}`); |
| 33 | + cy.visit(link || '/'); |
| 34 | + cy.get('a').each((el) => hrefWorks(el, link)); |
| 35 | + }); |
| 36 | +}); |
| 37 | + |
| 38 | +export {}; |
| 39 | + |
| 40 | +function hrefWorks(htmlTag: JQuery<HTMLElement>, link: string): void { |
| 41 | + const tagHref: string = htmlTag.prop('href'); |
| 42 | + const tagHash: string = htmlTag.prop('hash'); |
| 43 | + const tagText: string = htmlTag.prop('text'); |
| 44 | + const tagName: string = htmlTag.prop('tagName'); |
| 45 | + let pureHref: string; |
| 46 | + if (tagHref) { |
| 47 | + pureHref = tagHref.replace(tagHash, ''); // TODO: add test to validate links with a hash tag. |
| 48 | + logMessage({ evtName: 'CHECKING', link, pureHref, tagName, tagText }); |
| 49 | + |
| 50 | + if (allLinks.includes(`${pureHref.replace(`${BASE_URL}/`, '')}`)) { |
| 51 | + expect(`${pureHref.replace(`${BASE_URL}/`, '')}`).to.oneOf(allLinks); |
| 52 | + logMessage({ |
| 53 | + evtName: 'SKIPPING_SITEMAP', |
| 54 | + link, |
| 55 | + pureHref, |
| 56 | + tagName, |
| 57 | + tagText, |
| 58 | + }); |
| 59 | + } else if ( |
| 60 | + allLinks.includes(`${pureHref.replace(`${BASE_URL}/`, 'react/')}`) |
| 61 | + ) { |
| 62 | + expect(`${pureHref.replace(`${BASE_URL}/`, 'react/')}`).to.oneOf( |
| 63 | + allLinks |
| 64 | + ); |
| 65 | + logMessage({ |
| 66 | + evtName: 'SKIPPING_SITEMAP', |
| 67 | + link, |
| 68 | + pureHref, |
| 69 | + tagName, |
| 70 | + tagText, |
| 71 | + }); |
| 72 | + } else if ( |
| 73 | + VALIDATED_LINKS.includes(pureHref) || |
| 74 | + VALIDATED_LINKS.includes(`${pureHref.replace(BASE_URL, '')}`) || |
| 75 | + requestedLinks.has(pureHref) |
| 76 | + ) { |
| 77 | + logMessage({ |
| 78 | + evtName: 'SKIPPING_VALIDATED', |
| 79 | + link, |
| 80 | + pureHref, |
| 81 | + tagName, |
| 82 | + tagText, |
| 83 | + }); |
| 84 | + } else { |
| 85 | + const requestMethod = REQUEST_GET_LINKS.includes(pureHref) |
| 86 | + ? 'GET' |
| 87 | + : 'HEAD'; |
| 88 | + logMessage({ |
| 89 | + evtName: 'REQUESTING', |
| 90 | + link, |
| 91 | + pureHref, |
| 92 | + tagName, |
| 93 | + tagText, |
| 94 | + }); |
| 95 | + requestedLinks.add(pureHref); |
| 96 | + cy.request({ |
| 97 | + url: pureHref, |
| 98 | + followRedirect: false, |
| 99 | + method: requestMethod, |
| 100 | + }).then(({ status }) => { |
| 101 | + logMessage({ |
| 102 | + evtName: 'RETURNING', |
| 103 | + link, |
| 104 | + pureHref, |
| 105 | + tagName, |
| 106 | + tagText, |
| 107 | + status, |
| 108 | + }); |
| 109 | + expect(status).to.oneOf([200, 301, 303]); |
| 110 | + cy.clearLocalStorage(); |
| 111 | + }); |
| 112 | + } |
| 113 | + } else if (tagName === 'A') { |
| 114 | + logMessage({ evtName: 'NO_HREF', link, pureHref, tagName, tagText }); |
| 115 | + } |
| 116 | +} |
| 117 | + |
| 118 | +function logMessage({ |
| 119 | + evtName, |
| 120 | + link, |
| 121 | + pureHref, |
| 122 | + status, |
| 123 | + tagName, |
| 124 | + tagText, |
| 125 | +}: { |
| 126 | + evtName: EvtName; |
| 127 | + link: string; |
| 128 | + pureHref: string; |
| 129 | + status?: number; |
| 130 | + tagName: string; |
| 131 | + tagText: string; |
| 132 | +}) { |
| 133 | + switch (evtName) { |
| 134 | + case 'CHECKING': |
| 135 | + return cy.task( |
| 136 | + 'log', |
| 137 | + `🔍[CHECKING...] ${pureHref} from ${tagName} tag ${ |
| 138 | + tagText ? `"${tagText}"` : '' |
| 139 | + } on ${BASE_URL}/${link}` |
| 140 | + ); |
| 141 | + case 'SKIPPING_SITEMAP': |
| 142 | + return cy.task( |
| 143 | + 'log', |
| 144 | + `⏭[SKIPPING...] ${pureHref} from ${tagName} tag ${ |
| 145 | + tagText ? `"${tagText}"` : '' |
| 146 | + } on ${BASE_URL}/${link} because it's included in Sitemap and already tested.` |
| 147 | + ); |
| 148 | + case 'SKIPPING_VALIDATED': |
| 149 | + return cy.task( |
| 150 | + 'log', |
| 151 | + `⏭[SKIPPING...] ${pureHref} from ${tagName} tag ${ |
| 152 | + tagText ? `"${tagText}"` : '' |
| 153 | + } on ${BASE_URL}/${link} because it's already validated.` |
| 154 | + ); |
| 155 | + case 'REQUESTING': |
| 156 | + return cy.task( |
| 157 | + 'log', |
| 158 | + `📞[REQUESTING...] ${pureHref} from ${tagName} tag ${ |
| 159 | + tagText ? `"${tagText}"` : '' |
| 160 | + } on ${BASE_URL}/${link}` |
| 161 | + ); |
| 162 | + case 'RETURNING': |
| 163 | + return cy.task( |
| 164 | + 'log', |
| 165 | + `↩️ [RETURNING STATUS...] ${status} for ${pureHref}` |
| 166 | + ); |
| 167 | + case 'NO_HREF': |
| 168 | + return cy.task( |
| 169 | + 'log', |
| 170 | + `⚠ ${tagName} tag ${ |
| 171 | + tagText ? `"${tagText}"` : '' |
| 172 | + } on ${BASE_URL}/${link} doesn't have a href attribute` |
| 173 | + ); |
| 174 | + default: |
| 175 | + break; |
| 176 | + } |
| 177 | +} |
0 commit comments