Skip to content

pulsar
pulsar

apache / pulsar

通知 129
Star 40
Fork 3
pulsar
pulsar

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

提交 c5c44a92 编写于 作者: C cckellogg 提交者： Matteo Merli
浏览文件
操作

Add test for links to other markdown docs. (#5411) 

* Add test for links to other markdown docs.

* Remove unused import.
上级 ba6dfaf2
隐藏空白更改
内联 并排
Showing with 75 addition and 382 deletion
site2/README.md
浏览文件 @ c5c44a92
......@@ -27,6 +27,14 @@ yarn start
> 2. After you enter the `yarn start` command, you will be navigated to a local address, for example, `http://localhost:3000`. Click `Docs` to see documentation for the latest release of Pulsar.
> 3. The `http://localhost:3000/en/versions` path shows the documentation for all versions. To view your local changes, click `Documentation` in **Latest Version**, or enter `http://localhost:3000/docs/en/next/standalone` in a browser.
### Tests
To run tests locally, enter the following commands
```bash
cd pulsar/site2/website
yarn test
```
## Documentation
Pulsar documents are written in English. Documentation related pages are placed in the `/site2/docs` directory. All documentation pages are versioned. For more details, refer to [versioning](#versioning).
......
site2/website/__tests__/doc-links.test.js 0 → 100644
浏览文件 @ c5c44a92
const CWD = process.cwd();
const path = require('path');
const fs = require('fs');
const docsDir = path.join(CWD, '../', 'docs');
test('markdown doc links', async () => {
const docsDir = path.join(CWD, '../', 'docs');
const pages = new Set();
// collect all doc pages
fs.readdirSync(docsDir).forEach(file => {
if (file.endsWith('.md')) {
pages.add(file);
}
});
const mdBrokenLinks = []
pages.forEach(page => {
const pageFile = path.join(docsDir, page)
const mdLinks = getPageMDLinks(pageFile);
const brokenLinks = []
new Set(mdLinks).forEach(link => {
if (!pages.has(link)) {
brokenLinks.push(link);
}
})
if (brokenLinks.length > 0) {
mdBrokenLinks.push({page: page, brokenLinks: brokenLinks})
}
})
// did we find some broken links?
if (mdBrokenLinks.length > 0) {
const brokenLinksJson = JSON.stringify(mdBrokenLinks, null, 2);
const errorMessage = `Found the following broken links in docs pages:\n${brokenLinksJson}`
console.log(errorMessage);
expect(mdBrokenLinks.length).toBe(0)
}
})
function getPageMDLinks(file) {
if (!fs.existsSync(file)) {
return [];
}
const content = fs.readFileSync(file, 'utf8');
const mdLinks = [];
// find any inline-style links to markdown files
const linkRegex = /(?:\]\()(?:\.\/)?([^'")\]\s>]+\.md)/g;
let linkMatch = linkRegex.exec(content);
while (linkMatch !== null) {
const link = linkMatch[1]
// we are only checking links to other docs in this test
if (!link.startsWith('http')) {
mdLinks.push(linkMatch[1]);
}
linkMatch = linkRegex.exec(content);
}
return mdLinks;
}
site2/website/__tests__/docs.test.js 已删除 100644 → 0
浏览文件 @ ba6dfaf2
const puppeteer = require('puppeteer')
const axios = require('axios');
const CWD = process.cwd();
const siteConfig = require(`${CWD}/siteConfig.js`);
const timeoutMs = 60000;
let browser;
let navLinks = [];
let navGroups = [];
function standaloneDocUrl() {
return `http://localhost:3000${siteConfig.baseUrl}docs/standalone`
}
async function loadNavLinks() {
let page = await browser.newPage();
await page.goto(standaloneDocUrl());
const hrefs = await page.evaluate(
() => Array.from(document.body.querySelectorAll('a.navItem[href]'), ({ href }) => href)
);
navLinks = hrefs;
const ng = await page.evaluate(
() => Array.from(document.body.querySelectorAll('.navGroups'))
);
navGroups = ng;
}
async function newPage() {
const page = await browser.newPage();
await page.goto(standaloneDocUrl());
return page
}
expect.extend({
toBeTruthyWithMessage(received, errMsg) {
const result = {
pass: received,
message: () => errMsg
};
return result;
}
});
beforeAll(async () => {
browser = await puppeteer.launch({})
await loadNavLinks()
})
async function docLinks(page) {
const hrefs = await page.evaluate(function() {
const main = document.body.querySelector('.mainContainer');
const article = document.querySelector('article')
// https://github.com/GoogleChrome/puppeteer/issues/2479
return Array.from(article.querySelectorAll('a[href]'), ({href}) => href.split('#')[0]);
});
return new Set(hrefs)
}
async function findNavLinks(page, title) {
const links = await page.evaluate(function(title) {
const navGroups = Array.from(document.body.querySelectorAll('.navGroup'));
for (ng of navGroups) {
if (title === ng.children[0].innerText) {
return Array.from(ng.querySelectorAll('a[href]'), ({href}) => href)
}
}
return []
}, title)
return links
}
function ok(response) {
return response.status() === 200 || response.status() === 304
}
function shouldSkipLink(link) {
if (link.includes('mailto:')) {
return true
}
if (link.includes('/api/')) {
return true
}
if (link.includes('localhost:8001')) {
return true
}
if (link.includes('localhost:8080')) {
return true
}
if (link.includes('localhost:4000')) {
return true
}
if (link.includes('localhost:6650')) {
return true
}
if (link.includes('localhost:3000')) {
return true
}
if (link.includes('.dcos')) {
return true
}
if (link.includes('192.168')) {
return true
}
if (link.includes('org.apache.pulsar:')) {
return true
}
if (link.includes('websockets.')) {
return true
}
if (link.includes('logging.apache.org')) {
return true
}
if (link.includes('pulsar:')) {
return true
}
return false
}
async function testDocLinks(page, links) {
const results = []
for (l of links) {
// console.log("checking doc links for", l)
await page.goto(l)
const doclinks = await docLinks(page)
const result = {
url: l,
broken: []
}
for (dl of doclinks) {
if (shouldSkipLink(dl)) {
continue
}
// console.log(" doc link", dl)
try {
const response = await axios.get(dl);
} catch (error) {
console.log(error);
result.broken.push(dl);
}
}
if (result.broken.length > 0) {
results.push(result)
}
}
return results
}
function assertResults(results) {
let errMsg = ""
for (r of results) {
let msg = `${r.url} contains broken links:\n`
for (bl of r.broken) {
msg += `\t${bl}\n`
}
errMsg += msg
}
expect(results.length == 0).toBeTruthyWithMessage(errMsg)
}
test('Getting started', async() => {
const page = await newPage()
const links = await findNavLinks(page, 'Getting started')
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results)
}, timeoutMs)
test('Pulsar Functions', async() => {
const page = await newPage()
const links = await findNavLinks(page, 'Pulsar Functions')
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results)
}, timeoutMs)
test('Pulsar IO', async() => {
const page = await newPage()
const links = await findNavLinks(page, 'Pulsar IO')
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results);
}, timeoutMs)
test('Deployment', async() => {
const page = await newPage()
const links = await findNavLinks(page, 'Deployment')
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results);
}, 180000)
test('Pulsar administration', async() => {
const page = await newPage()
const links = await findNavLinks(page, 'Pulsar administration')
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results);
}, timeoutMs)
test('Security', async() => {
const page = await newPage()
const links = await findNavLinks(page, 'Security')
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results);
}, 180000)
test('Client libraries', async() => {
const page = await newPage()
const links = await findNavLinks(page, 'Client libraries')
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results);
}, timeoutMs)
test('Admin API', async() => {
const page = await newPage();
const links = await findNavLinks(page, 'Admin API');
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results);
}, timeoutMs)
test('Adaptors', async() => {
const page = await newPage();
const links = await findNavLinks(page, 'Adaptors');
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results);
}, timeoutMs)
test('Development', async() => {
const page = await newPage();
const links = await findNavLinks(page, 'Development');
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results);
}, 180000)
test('Reference', async() => {
const page = await newPage()
const links = await findNavLinks(page, 'Reference')
expect(links.length).toBeGreaterThan(0);
for (l of links) {
const response = await axios.get(l);
expect(response.status).toBe(200);
}
const results = await testDocLinks(page, links);
assertResults(results);
}, timeoutMs)
afterAll(() => {
if (browser) {
browser.close()
}
})
site2/website/__tests__/index.test.js 已删除 100644 → 0
浏览文件 @ ba6dfaf2
const puppeteer = require('puppeteer')
let browser;
beforeAll(async () => {
browser = await puppeteer.launch({})
})
afterAll(() => {
if (browser) {
browser.close()
}
})
test('key feature links', async () => {
expect(3).toBe(3);
});
site2/website/jest-puppeteer.config.js 已删除 100644 → 0
浏览文件 @ ba6dfaf2
module.exports = {
launch: {
headless: true,
},
server: {
command: 'yarn start --no-watch',
port: 3000,
launchTimeout: 10000,
},
}
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或