test: increase coverage

Signed-off-by: Andres Correa Casablanca <[email protected]>

@kindspells/astro-shield/moon.yml

@@ -73,3 +73,9 @@ tasks:
       - 'coverage-unit/**/*'
     deps:
       - '~:build'
+  test:
+    deps:
+      - '~:test.unit.cov'
+      - '~:test.e2e'
+    options:
+      runInCI: false

@kindspells/astro-shield/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@kindspells/astro-shield",
-	"version": "1.5.2",
+	"version": "1.5.3",
 	"description": "Astro integration to enhance your website's security with SubResource Integrity hashes, Content-Security-Policy headers, and other techniques.",
 	"private": false,
 	"type": "module",

@kindspells/astro-shield/src/core.mts

@@ -24,6 +24,7 @@ import type {
 	StrictShieldOptions,
 } from './types.mts'
 import { patchNetlifyHeadersConfig } from './netlify.mts'
+import { exhaustiveGuard } from './utils.mts'
 
 export type HashesModule = {
 	[k in keyof HashesCollection]: HashesCollection[k] extends Set<string>
@@ -33,10 +34,6 @@ export type HashesModule = {
 			: Record<'scripts' | 'styles', Record<string, string>>
 }
 
-const exhaustiveGuard = (_v: never, caseName: string): void => {
-	throw new Error(`Unknown ${caseName}: ${_v}`)
-}
-
 export const generateSRIHash = (
 	data: string | ArrayBuffer | Buffer,
 ): string => {
@@ -964,7 +961,8 @@ export const onRequest = await (async () => {
 `
 }
 
-const getViteMiddlewarePlugin = (
+/** @internal */
+export const getViteMiddlewarePlugin = (
 	logger: Logger,
 	sri: Required<SRIOptions>,
 	securityHeaders: SecurityHeadersOptions | undefined,

@kindspells/astro-shield/src/fs.mts

@@ -9,6 +9,7 @@ import { resolve } from 'node:path'
 
 import type { HashesCollection, Logger, SRIOptions } from './types.mts'
 
+/** @internal */
 export const doesFileExist = async (path: string): Promise<boolean> => {
 	try {
 		await stat(path)
@@ -21,6 +22,7 @@ export const doesFileExist = async (path: string): Promise<boolean> => {
 	}
 }
 
+/** @internal */
 export const scanDirectory = async (
 	logger: Logger,
 	currentPath: string,

@kindspells/astro-shield/src/main.mts

@@ -51,7 +51,7 @@ export const shield = ({
 	} satisfies Required<SRIOptions>
 
 	if (_sri.hashesModule && _sri.enableStatic === false) {
-		logWarn('`sriHashesModule` is ignored when `enableStatic_SRI` is `false`')
+		logWarn('`sri.hashesModule` is ignored when `sri.enableStatic` is `false`')
 	}
 
 	return {

@kindspells/astro-shield/src/netlify.mts

@@ -127,11 +127,11 @@ const processPathLine = (
 ): void => {
 	let match: RegExpMatchArray | null = null
 
-	// biome-ignore lint/suspicious/noAssignInExpressions: <explanation>
+	// biome-ignore lint/suspicious/noAssignInExpressions: best way to do it
 	if ((match = commentRegex.exec(line))) {
 		pushEntry(match, lineNum, line, pushComment, ctx)
 	}
-	// biome-ignore lint/suspicious/noAssignInExpressions: <explanation>
+	// biome-ignore lint/suspicious/noAssignInExpressions: best way to do it
 	else if ((match = headerRegex.exec(line))) {
 		pushEntry(match, lineNum, line, pushHeader, ctx)
 	} else if (!spacesRegex.test(line)) {
@@ -211,7 +211,8 @@ const compareConfigEntries = (
 				: 0
 }
 
-const comparePathEntries = (
+/** @internal */
+export const comparePathEntries = (
 	a: HeaderEntry | CommentEntry,
 	b: HeaderEntry | CommentEntry,
 ): -1 | 0 | 1 => {
@@ -229,7 +230,8 @@ const comparePathEntries = (
 						: 0
 }
 
-const comparePathEntriesSimplified = (
+/** @internal */
+export const comparePathEntriesSimplified = (
 	a: HeaderEntry | CommentEntry,
 	b: HeaderEntry | CommentEntry,
 ): -1 | 0 | 1 => {
@@ -344,11 +346,11 @@ const mergeNetlifyPathHeaders = (
 		}
 	}
 	for (; baseIndex < base.length; baseIndex += 1) {
-		// biome-ignore lint/style/noNonNullAssertion: <explanation>
+		// biome-ignore lint/style/noNonNullAssertion: guaranteed to exist
 		merged.push(base[baseIndex]!)
 	}
 	for (; patchIndex < patch.length; patchIndex += 1) {
-		// biome-ignore lint/style/noNonNullAssertion: <explanation>
+		// biome-ignore lint/style/noNonNullAssertion: guaranteed to exist
 		merged.push(patch[patchIndex]!)
 	}
 

@kindspells/astro-shield/src/tests/core.test.mts

@@ -21,6 +21,8 @@ import {
 	sriHashesEqual,
 	updateDynamicPageSriHashes,
 	updateStaticPageSriHashes,
+	getAstroConfigSetup,
+	getViteMiddlewarePlugin,
 } from '../core.mts'
 import { doesFileExist } from '../fs.mts'
 
@@ -2029,3 +2031,67 @@ describe('getCSPMiddlewareHandler', () => {
 </html>`)
 	})
 })
+
+describe('getViteMiddlewarePlugin', () => {
+	it('returns a vite middleware plugin object', async () => {
+		const plugin = getViteMiddlewarePlugin(
+			console,
+			{
+				enableStatic: false,
+				enableMiddleware: false,
+				allowInlineScripts: false,
+				allowInlineStyles: false,
+				hashesModule: '/path/to/hashes.mjs',
+				scriptsAllowListUrls: [],
+				stylesAllowListUrls: [],
+			},
+			{},
+			'/path/to/site/',
+		)
+
+		expect(plugin).toHaveProperty('name')
+		expect(plugin).toHaveProperty('resolveId')
+		expect(plugin).toHaveProperty('load')
+
+		expect(plugin.name).toBe('vite-plugin-astro-shield')
+
+		assert(typeof plugin.resolveId === 'function')
+		expect(
+			(plugin.resolveId as unknown as (a: string) => string | undefined)(
+				'virtual:@kindspells/astro-shield/middleware',
+			),
+		).toStrictEqual('\u0000virtual:@kindspells/astro-shield/middleware')
+		expect(
+			(plugin.resolveId as unknown as (a: string) => string | undefined)(
+				'virtual:@something/else/middleware',
+			),
+		).toStrictEqual(undefined)
+
+		assert(typeof plugin.load === 'function')
+		// We won't check the "happy path" because it triggers too many side effects
+		expect(
+			await (plugin.load as (a: string) => Promise<string | undefined>)(
+				'virtual:@something/else/middleware',
+			),
+		).toStrictEqual(undefined)
+	})
+})
+
+describe('getAstroConfigSetup', () => {
+	// We don't test anything else because it would trigger too many side effects
+	it('returns an "astro:config:setup" hook function', () => {
+		const setup = getAstroConfigSetup(
+			{
+				enableStatic: false,
+				enableMiddleware: false,
+				allowInlineScripts: false,
+				allowInlineStyles: false,
+				hashesModule: '/path/to/hashes.mjs',
+				scriptsAllowListUrls: [],
+				stylesAllowListUrls: [],
+			},
+			{},
+		)
+		expect(typeof setup).toBe('function')
+	})
+})

@kindspells/astro-shield/src/tests/netlify.test.mts

@@ -5,6 +5,8 @@ import { describe, expect, it } from 'vitest'
 import type { NetlifyHeadersRawConfig } from '../netlify.mts'
 import {
 	buildNetlifyHeadersConfig,
+	comparePathEntries,
+	comparePathEntriesSimplified,
 	mergeNetlifyHeadersConfig,
 	parseNetlifyHeadersConfig,
 	readNetlifyHeadersFile,
@@ -31,6 +33,104 @@ const testEntries = [
 	},
 ] satisfies NetlifyHeadersRawConfig['entries']
 
+describe('comparePathEntries', () => {
+	it.each([
+		[{ comment: 'Comment A' }, { comment: 'Comment B' }],
+		[
+			{ comment: 'Comment A' },
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+		],
+		[
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+			{ comment: 'Comment A' },
+		],
+	] as const)('returns 0 if there is any comment', (entryA, entryB) => {
+		expect(comparePathEntries(entryA, entryB)).toBe(0)
+	})
+
+	it.each([
+		[
+			{ headerName: 'Authorization', value: 'Bearer 0123456789abcdef' },
+			{ headerName: 'Authorization', value: 'Bearer 0123456789abcdef' },
+			0,
+		],
+		[
+			{ headerName: 'Authorization', value: 'Bearer 0123456789abcdef' },
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+			-1,
+		],
+		[
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+			{ headerName: 'Authorization', value: 'Bearer 0123456789abcdef' },
+			1,
+		],
+		[
+			{ headerName: 'X-Frame-Options', value: 'ALLOW' },
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+			-1,
+		],
+		[
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+			{ headerName: 'X-Frame-Options', value: 'ALLOW' },
+			1,
+		],
+	] as const)(
+		'compares headers by name and value',
+		(entryA, entryB, result) => {
+			expect(comparePathEntries(entryA, entryB)).toBe(result)
+		},
+	)
+})
+
+describe('comparePathEntriesSimplified', () => {
+	it.each([
+		[{ comment: 'Comment A' }, { comment: 'Comment B' }],
+		[
+			{ comment: 'Comment A' },
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+		],
+		[
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+			{ comment: 'Comment A' },
+		],
+	] as const)('returns 0 if there is any comment', (entryA, entryB) => {
+		expect(comparePathEntriesSimplified(entryA, entryB)).toBe(0)
+	})
+
+	it.each([
+		[
+			{ headerName: 'Authorization', value: 'Bearer 0123456789abcdef' },
+			{ headerName: 'Authorization', value: 'Bearer 0123456789abcdef' },
+			0,
+		],
+		[
+			{ headerName: 'Authorization', value: 'Bearer 0123456789abcdef' },
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+			-1,
+		],
+		[
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+			{ headerName: 'Authorization', value: 'Bearer 0123456789abcdef' },
+			1,
+		],
+		[
+			{ headerName: 'X-Frame-Options', value: 'ALLOW' },
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+			0,
+		],
+		[
+			{ headerName: 'X-Frame-Options', value: 'DENY' },
+			{ headerName: 'X-Frame-Options', value: 'ALLOW' },
+			0,
+		],
+	] as const)(
+		'compares headers by name and value',
+		(entryA, entryB, result) => {
+			expect(comparePathEntriesSimplified(entryA, entryB)).toBe(result)
+		},
+	)
+})
+
 describe('parseNetlifyHeadersConfig', () => {
 	it('parses a valid config (tabs)', () => {
 		const config = `# This is a test config file

@kindspells/astro-shield/src/tests/utils.test.mts

@@ -0,0 +1,11 @@
+import { describe, expect, it } from 'vitest'
+
+import { exhaustiveGuard } from '../utils.mts'
+
+describe('exhaustiveGuard', () => {
+	it('does something', () => {
+		expect(() => exhaustiveGuard('x' as never, 'something')).toThrowError(
+			'Unknown something: x',
+		)
+	})
+})

@kindspells/astro-shield/src/utils.mts

@@ -0,0 +1,4 @@
+/** @internal */
+export const exhaustiveGuard = (_v: never, caseName: string): void => {
+	throw new Error(`Unknown ${caseName}: ${_v}`)
+}

@kindspells/astro-shield/vitest.config.unit.mts

@@ -20,10 +20,10 @@ export default defineConfig({
 				'coverage-unit/**/*',
 			],
 			thresholds: {
-				statements: 75.0, // TODO: 77.0,
-				branches: 78.0,
-				functions: 80.0, // TODO: 87.0,
-				lines: 75.0, // TODO: 77.0,
+				statements: 78.0,
+				branches: 80.0,
+				functions: 88.0,
+				lines: 78.0,
 			},
 			reportsDirectory: 'coverage-unit',
 		},