astro/packages/integrations/sitemap/test/trailing-slash.test.js

import assert from 'node:assert/strict';
import { before, describe, it } from 'node:test';
import { loadFixture, readXML } from './test-utils.js';

describe('Trailing slash', () => {
	/** @type {import('./test-utils').Fixture} */
	let fixture;

	describe('trailingSlash: ignore', () => {
		describe('build.format: directory', () => {
			before(async () => {
				fixture = await loadFixture({
					root: './fixtures/trailing-slash/',
					trailingSlash: 'ignore',
					build: {
						format: 'directory',
					},
				});
				await fixture.build();
			});

			it('URLs end with trailing slash', async () => {
				const data = await readXML(fixture.readFile('/sitemap-0.xml'));
				const urls = data.urlset.url;

				assert.equal(urls[0].loc[0], 'http://example.com/');
				assert.equal(urls[1].loc[0], 'http://example.com/one/');
				assert.equal(urls[2].loc[0], 'http://example.com/two/');
			});
		});

		describe('build.format: file', () => {
			before(async () => {
				fixture = await loadFixture({
					root: './fixtures/trailing-slash/',
					trailingSlash: 'ignore',
					build: {
						format: 'file',
					},
				});
				await fixture.build();
			});

			it('URLs do not end with trailing slash', async () => {
				const data = await readXML(fixture.readFile('/sitemap-0.xml'));
				const urls = data.urlset.url;

				assert.equal(urls[0].loc[0], 'http://example.com');
				assert.equal(urls[1].loc[0], 'http://example.com/one');
				assert.equal(urls[2].loc[0], 'http://example.com/two');
			});
		});
	});

	describe('trailingSlash: never', () => {
		before(async () => {
			fixture = await loadFixture({
				root: './fixtures/trailing-slash/',
				trailingSlash: 'never',
			});
			await fixture.build();
		});

		it('URLs do not end with trailing slash', async () => {
			const data = await readXML(fixture.readFile('/sitemap-0.xml'));
			const urls = data.urlset.url;

			assert.equal(urls[0].loc[0], 'http://example.com');
			assert.equal(urls[1].loc[0], 'http://example.com/one');
			assert.equal(urls[2].loc[0], 'http://example.com/two');
		});
		describe('with base path', () => {
			before(async () => {
				fixture = await loadFixture({
					root: './fixtures/trailing-slash/',
					trailingSlash: 'never',
					base: '/base',
				});
				await fixture.build();
			});

			it('URLs do not end with trailing slash', async () => {
				const data = await readXML(fixture.readFile('/sitemap-0.xml'));
				const urls = data.urlset.url;
				assert.equal(urls[0].loc[0], 'http://example.com/base');
				assert.equal(urls[1].loc[0], 'http://example.com/base/one');
				assert.equal(urls[2].loc[0], 'http://example.com/base/two');
			});
		});
	});

	describe('trailingSlash: always', () => {
		before(async () => {
			fixture = await loadFixture({
				root: './fixtures/trailing-slash/',
				trailingSlash: 'always',
			});
			await fixture.build();
		});

		it('URLs end with trailing slash', async () => {
			const data = await readXML(fixture.readFile('/sitemap-0.xml'));
			const urls = data.urlset.url;
			assert.equal(urls[0].loc[0], 'http://example.com/');
			assert.equal(urls[1].loc[0], 'http://example.com/one/');
			assert.equal(urls[2].loc[0], 'http://example.com/two/');
		});
		describe('with base path', () => {
			before(async () => {
				fixture = await loadFixture({
					root: './fixtures/trailing-slash/',
					trailingSlash: 'always',
					base: '/base',
				});
				await fixture.build();
			});

			it('URLs end with trailing slash', async () => {
				const data = await readXML(fixture.readFile('/sitemap-0.xml'));
				const urls = data.urlset.url;
				assert.equal(urls[0].loc[0], 'http://example.com/base/');
				assert.equal(urls[1].loc[0], 'http://example.com/base/one/');
				assert.equal(urls[2].loc[0], 'http://example.com/base/two/');
			});
		});
	});
});