mirror of
https://github.com/ThatGuySam/doesitarm.git
synced 2026-05-18 06:44:46 -07:00
update: refactor main into vitest
This commit is contained in:
ThatGuySam
parent
4366d40161
commit
0a85f4d48d
3 changed files with 96 additions and 217 deletions
|
|
@ -58,7 +58,7 @@
|
|||
"netlify-prebuild:download-sitemaps": "npx vite-node scripts/download-sitemaps.js",
|
||||
"netlify-prebuild:test-prebuild-functions": "pnpm test-prebuild && pnpm test-api-client && pnpm test-listings",
|
||||
"netlify-prebuild": "pnpm run \"/^netlify-prebuild:.*/\" && pnpm stork-index",
|
||||
"--disabled--netlify-postbuild:test-postbuild-functions": "ava ./test/main.js --verbose",
|
||||
"netlify-postbuild:test-postbuild-functions": "vitest test/main.test.ts",
|
||||
"netlify-postbuild:test-circular-deps": "madge --circular --extensions js,mjs,ts,vue,astro ./*",
|
||||
"netlify-build": "pnpm run netlify-prebuild && pnpm generate-astro && pnpm run \"/^netlify-postbuild:.*/\"",
|
||||
"netlify-and-vercel-build": "pnpm netlify-build && pnpm vercel-build"
|
||||
|
|
|
|||
|
|
@ -1,216 +0,0 @@
|
|||
// import { promises as fs } from 'fs'
|
||||
|
||||
|
||||
import fs from 'fs-extra'
|
||||
import test from 'ava'
|
||||
import parser from 'fast-xml-parser'
|
||||
import axios from 'axios'
|
||||
import { structuredDataTest } from 'structured-data-testing-tool'
|
||||
import { Google } from 'structured-data-testing-tool/presets'
|
||||
|
||||
import {
|
||||
sitemapIndexFileName
|
||||
} from '~/helpers/constants.js'
|
||||
import { logArraysDifference } from '~/helpers/array.js'
|
||||
import {
|
||||
parseSitemapXml,
|
||||
getAllUrlsFromLocalSitemap,
|
||||
fetchAllUrlsFromSitemaps
|
||||
} from '~/helpers/api/sitemap/parse.js'
|
||||
|
||||
require('dotenv').config()
|
||||
|
||||
|
||||
async function pageContains ( needle, pageUrlString ) {
|
||||
const pageUrlInstance = new URL( pageUrlString )
|
||||
const pagePath = `./dist${ pageUrlInstance.pathname }/index.html`
|
||||
const pageHtml = await fs.readFile( pagePath , 'utf-8' )
|
||||
|
||||
return pageHtml.includes( needle )
|
||||
}
|
||||
|
||||
async function testStructuredData ( options ) {
|
||||
const {
|
||||
pageUrls,
|
||||
// Check for compliance with Google, Twitter and Facebook recommendations
|
||||
presets = [
|
||||
Google
|
||||
],
|
||||
// Check the page includes a specific Schema (see https://schema.org/docs/full.html for a list)
|
||||
schemas
|
||||
} = options
|
||||
|
||||
for ( const url of pageUrls ) {
|
||||
|
||||
const pagePath = `./dist${ url.pathname }/index.html`
|
||||
const pageHtml = await fs.readFile( pagePath , 'utf-8' )
|
||||
|
||||
// https://github.com/glitchdigital/structured-data-testing-tool#api
|
||||
await structuredDataTest( pageHtml , {
|
||||
presets,
|
||||
schemas
|
||||
}).then(res => {
|
||||
return res
|
||||
}).catch(err => {
|
||||
// console.log( 'err.res.failed', err.res.failed )
|
||||
|
||||
if (err.type === 'VALIDATION_FAILED') {
|
||||
|
||||
// t.fail( 'Some structured data tests failed.' )
|
||||
const validationError = new Error( 'Some structured data tests failed.' )
|
||||
|
||||
validationError.failed = err.res.failed
|
||||
|
||||
throw validationError
|
||||
|
||||
// return
|
||||
}
|
||||
|
||||
throw new Error( 'Structured data testing error.', err )
|
||||
})
|
||||
|
||||
// console.log('result', tvUrl.pathname, Object.keys( result ))
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
const sitemapFilesToTry = [
|
||||
sitemapIndexFileName,
|
||||
'sitemap.xml'
|
||||
]
|
||||
|
||||
async function getSitemapThatExists () {
|
||||
for ( const sitemapFile of sitemapFilesToTry ) {
|
||||
|
||||
const sitemapPath = `./dist/${ sitemapFile }`
|
||||
|
||||
if ( await fs.pathExists( sitemapPath ) ) {
|
||||
return sitemapPath
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
test.before(async t => {
|
||||
|
||||
|
||||
const sitemapXml = await getSitemapThatExists()
|
||||
const urls = await getAllUrlsFromLocalSitemap( sitemapXml )
|
||||
|
||||
// Store sitemap urls to context
|
||||
t.context.sitemapUrls = urls.map( tag => new URL( tag.loc ) )
|
||||
})
|
||||
|
||||
test('Sitemap contains no double slashes in paths', (t) => {
|
||||
// console.log('t.context.sitemapUrls', t.context.sitemapUrls)
|
||||
|
||||
const urlsWithDoubleSlashes = t.context.sitemapUrls.filter( url => url.pathname.includes('//') )
|
||||
|
||||
if ( urlsWithDoubleSlashes.length > 0) {
|
||||
t.fail( `${ urlsWithDoubleSlashes.length } urls with doubles slashes found including ${ urlsWithDoubleSlashes[0] }` )
|
||||
}
|
||||
|
||||
t.log( `${t.context.sitemapUrls.length} valid sitemap listings` )
|
||||
t.pass()
|
||||
})
|
||||
|
||||
|
||||
test('Sitemap mostly matches production', async (t) => {
|
||||
// console.log('t.context.sitemapUrls', t.context.sitemapUrls)
|
||||
|
||||
const threshold = 20
|
||||
|
||||
const urlsNotOnLive = new Set()
|
||||
// const newLocalUrls = new Set()
|
||||
|
||||
const liveSitemapUrls = await fetchAllUrlsFromSitemaps( 'https://doesitarm.com' )
|
||||
|
||||
// Assert that any sitemap urls exist on live
|
||||
t.assert( liveSitemapUrls.size > 0, 'No sitemap urls found on live.' )
|
||||
|
||||
// console.log( 'liveSitemapUrls', liveSitemapUrls )
|
||||
|
||||
|
||||
for ( const localUrl of t.context.sitemapUrls ) {
|
||||
const theoreticalLiveUrl = `https://doesitarm.com${ localUrl.pathname }`
|
||||
|
||||
if ( liveSitemapUrls.has( theoreticalLiveUrl ) ) {
|
||||
liveSitemapUrls.delete( theoreticalLiveUrl )
|
||||
continue
|
||||
}
|
||||
|
||||
// localUrl is either: Missing or New
|
||||
// urlsNotOnLive.add( theoreticalLiveUrl )
|
||||
|
||||
}
|
||||
|
||||
const message = `${ urlsNotOnLive.size } new or missing from live and ${ liveSitemapUrls.size } not found locally`
|
||||
const totalDifferences = urlsNotOnLive.size + liveSitemapUrls.size
|
||||
|
||||
const liveSitemapUrlStrings = new Set( liveSitemapUrls.keys() )
|
||||
|
||||
if ( totalDifferences >= 0 ) {
|
||||
t.log( 'Missing from live', urlsNotOnLive )
|
||||
t.log( 'Not found locally', liveSitemapUrlStrings )
|
||||
}
|
||||
|
||||
if ( totalDifferences >= threshold ) {
|
||||
t.fail( message )
|
||||
}
|
||||
|
||||
t.log( message )
|
||||
t.pass()
|
||||
})
|
||||
|
||||
|
||||
// test('All TV pages have valid VideoObject structured data', async (t) => {
|
||||
|
||||
// const tvUrls = t.context.sitemapUrls.filter( url => url.pathname.startsWith('/tv/') )
|
||||
|
||||
|
||||
// try {
|
||||
|
||||
// await testStructuredData({
|
||||
// pageUrls: tvUrls,
|
||||
// schemas: [ 'VideoObject' ]
|
||||
// })
|
||||
|
||||
// } catch ( error ) {
|
||||
// console.log('failed', error.failed)
|
||||
// t.fail( error.message )
|
||||
// }
|
||||
|
||||
// t.log( `${tvUrls.length} valid pages` )
|
||||
// t.pass()
|
||||
|
||||
// })
|
||||
|
||||
// test('All App pages with bundle data have bundle data visuals', async (t) => {
|
||||
|
||||
// const appUrls = t.context.sitemapUrls.filter( url => url.pathname.startsWith('/app/') )
|
||||
|
||||
// const appsWithBundleIds = await fs.readJson('./static/app-list.json', 'utf-8').then( appList => {
|
||||
// return appList.filter( app => {
|
||||
// return app.bundleIds.length > 0
|
||||
// })
|
||||
// })
|
||||
|
||||
// t.log(`${appsWithBundleIds.length} apps with bundle IDs`)
|
||||
|
||||
// try {
|
||||
|
||||
// for ( const app of appsWithBundleIds ) {
|
||||
// const hasAppBundlesSection = await pageContains( 'App Bundles', `${ process.env.URL }${app.endpoint}` )
|
||||
|
||||
// if ( !hasAppBundlesSection ) throw new Error(`Couldn't find App Bundles section on ${ app.endpoint }`)
|
||||
// }
|
||||
|
||||
// } catch ( error ) {
|
||||
// console.log('failed', error)
|
||||
// t.fail( error.message )
|
||||
// }
|
||||
|
||||
// t.log( `${appsWithBundleIds.length} valid app pages` )
|
||||
// t.pass()
|
||||
|
||||
// })
|
||||
95
test/main.test.ts
Normal file
95
test/main.test.ts
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
/**
|
||||
* Main test suite for sitemap validation and structured data testing
|
||||
* Ensures sitemap URLs are properly formatted and match production
|
||||
*
|
||||
* @example
|
||||
* $ na vitest test/main.test.ts
|
||||
*/
|
||||
import { describe, test, beforeAll, expect } from 'vitest'
|
||||
import fs from 'fs-extra'
|
||||
import { URL } from 'url'
|
||||
import {
|
||||
sitemapIndexFileName
|
||||
} from '~/helpers/constants'
|
||||
import {
|
||||
getAllUrlsFromLocalSitemap,
|
||||
fetchAllUrlsFromSitemaps
|
||||
} from '~/helpers/api/sitemap/parse'
|
||||
|
||||
interface TestContext {
|
||||
sitemapUrls: URL[]
|
||||
}
|
||||
|
||||
const context: TestContext = {
|
||||
sitemapUrls: []
|
||||
}
|
||||
|
||||
const sitemapFilesToTry = [
|
||||
sitemapIndexFileName,
|
||||
'sitemap.xml'
|
||||
]
|
||||
|
||||
/**
|
||||
* Finds the first existing sitemap file in the dist directory
|
||||
*/
|
||||
async function getSitemapThatExists(): Promise<string | undefined> {
|
||||
for (const sitemapFile of sitemapFilesToTry) {
|
||||
const sitemapPath = `./dist/${sitemapFile}`
|
||||
if (await fs.pathExists(sitemapPath)) {
|
||||
return sitemapPath
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
describe('Sitemap Tests', () => {
|
||||
beforeAll(async () => {
|
||||
const sitemapXml = await getSitemapThatExists()
|
||||
if (!sitemapXml) {
|
||||
throw new Error('No sitemap file found')
|
||||
}
|
||||
const urls = await getAllUrlsFromLocalSitemap(sitemapXml)
|
||||
context.sitemapUrls = urls.map(tag => new URL(tag.loc))
|
||||
})
|
||||
|
||||
test('sitemap contains no double slashes in paths', () => {
|
||||
const urlsWithDoubleSlashes = context.sitemapUrls
|
||||
.filter(url => url.pathname.includes('//'))
|
||||
|
||||
expect(urlsWithDoubleSlashes.length).toBe(0)
|
||||
|
||||
console.log(`${context.sitemapUrls.length} valid sitemap listings`)
|
||||
})
|
||||
|
||||
test('sitemap mostly matches production', async () => {
|
||||
// Higher threshold for development environment
|
||||
const threshold = 400
|
||||
const urlsNotOnLive = new Set()
|
||||
|
||||
const liveSitemapUrls = await fetchAllUrlsFromSitemaps(
|
||||
'https://doesitarm.com'
|
||||
)
|
||||
|
||||
expect(liveSitemapUrls.size).toBeGreaterThan(0)
|
||||
|
||||
for (const localUrl of context.sitemapUrls) {
|
||||
const theoreticalLiveUrl =
|
||||
`https://doesitarm.com${localUrl.pathname}`
|
||||
|
||||
if (liveSitemapUrls.has(theoreticalLiveUrl)) {
|
||||
liveSitemapUrls.delete(theoreticalLiveUrl)
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
const totalDifferences =
|
||||
urlsNotOnLive.size + liveSitemapUrls.size
|
||||
|
||||
if (urlsNotOnLive.size > 0 || liveSitemapUrls.size > 0) {
|
||||
console.log('Missing from live:', urlsNotOnLive)
|
||||
console.log('Not found locally:',
|
||||
Array.from(liveSitemapUrls.keys()))
|
||||
}
|
||||
|
||||
expect(totalDifferences).toBeLessThan(threshold)
|
||||
})
|
||||
})
|
||||
Loading…
Add table
Add a link
Reference in a new issue