Skip to content

Commit 6e6ba32

Browse files
BeyondEvilBeyondEvil
authored
Merge pull request pytest-dev#13 from drRedflint/linter
setup linter for project
2 parents ddda951 + 60c58ed commit 6e6ba32

File tree

12 files changed

+308
-350
lines changed

12 files changed

+308
-350
lines changed

‎.eslintrc.json

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,30 @@
11
{
22
"env": {
33
"browser": true,
4+
"commonjs": true,
45
"es2021": true
56
},
6-
"extends": "eslint:recommended",
7+
"extends": [
8+
"google"
9+
],
710
"parserOptions": {
8-
"ecmaVersion": 12
11+
"ecmaVersion": "latest"
912
},
1013
"rules": {
1114
"array-bracket-spacing": "error",
1215
"block-scoped-var": "error",
1316
"block-spacing": "error",
1417
"brace-style": "error",
15-
"camelcase": "error",
18+
"camelcase": "off",
1619
"class-methods-use-this": "error",
1720
"consistent-return": "error",
1821
"default-case": "error",
1922
"default-case-last": "error",
2023
"default-param-last": "error",
2124
"grouped-accessor-pairs": "error",
22-
"indent": [
23-
"error",
24-
4
25-
],
26-
"linebreak-style": [
27-
"error",
28-
"unix"
29-
],
25+
"indent": [ "error", 4 ],
26+
"linebreak-style": [ "error", "unix" ],
27+
"max-len": ["error", { "code": 120 }],
3028
"no-caller": "error",
3129
"no-console": "error",
3230
"no-empty-function": "error",
@@ -43,17 +41,25 @@
4341
"no-throw-literal": "error",
4442
"no-undefined": "error",
4543
"no-unreachable-loop": "error",
46-
"no-unused-expressions": "error",
44+
"no-unused-expressions": "off",
4745
"no-useless-backreference": "error",
4846
"no-useless-concat": "error",
4947
"no-var": "error",
48+
"object-curly-spacing": [
49+
"error",
50+
"always",
51+
{
52+
"arraysInObjects": true
53+
}
54+
],
5055
"prefer-const": "error",
5156
"prefer-promise-reject-errors": "error",
5257
"require-atomic-updates": "error",
5358
"require-await": "error",
59+
"require-jsdoc" : 0,
5460
"semi": [
5561
"error",
56-
"always"
62+
"never"
5763
],
5864
"quotes": [
5965
"error",

‎package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
"chai": "^4.3.6",
1414
"mocha": "^10.0.0",
1515
"sass": "^1.52.3",
16-
"sinon": "^14.0.0"
16+
"sinon": "^14.0.0",
17+
"eslint": "^8.20.0",
18+
"eslint-config-google": "^0.14.0"
1719
}
1820
}

‎src/pytest_html/scripts/datamanager.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
class DataManager {
2-
setManager(data){
2+
setManager(data) {
33
this.data = { ...data }
44
this.renderData = { ...data }
55
}
6-
getRawObject() {
6+
get allData() {
77
return { ...this.data }
88
}
99
resetRender() {
@@ -12,26 +12,26 @@ class DataManager {
1212
setRender(data) {
1313
this.renderData.tests = data
1414
}
15-
getRender() {
15+
get testSubset() {
1616
return [...this.renderData.tests]
1717
}
18-
getRaw() {
18+
get allTests() {
1919
return [...this.data.tests]
2020
}
21-
getTitle() {
21+
get title() {
2222
return this.renderData.title
2323
}
24-
getEnvironment() {
24+
get environment() {
2525
return this.renderData.environment
2626
}
27-
getCollectedItems() {
27+
get collectedItems() {
2828
return this.renderData.collectedItems
2929
}
30-
getDurationFormat() {
30+
get durationFormat() {
3131
return this.renderData.durationFormat
3232
}
3333
}
3434

3535
module.exports = {
36-
manager: new DataManager()
36+
manager: new DataManager(),
3737
}

‎src/pytest_html/scripts/dom.js

Lines changed: 94 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,109 @@
1-
const { formatDuration } = require('./utils.js');
2-
const imgViewer = require('./imgViewer.js');
3-
const templateEnvRow = document.querySelector('#template_environment_row');
4-
const templateResult = document.querySelector('#template_results-table__tbody');
5-
const aTag = document.querySelector('#template_a');
6-
const aTagImg = document.querySelector('#template_img');
7-
const listHeader = document.querySelector('#template_results-table__head');
8-
const listHeaderEmpty = document.querySelector('#template_results-table__head--empty');
1+
const { formatDuration } = require('./utils.js')
2+
const imgViewer = require('./imgViewer.js')
3+
const templateEnvRow = document.querySelector('#template_environment_row')
4+
const templateResult = document.querySelector('#template_results-table__tbody')
5+
const aTag = document.querySelector('#template_a')
6+
const listHeader = document.querySelector('#template_results-table__head')
7+
const listHeaderEmpty = document.querySelector('#template_results-table__head--empty')
98

109
function htmlToElements(html) {
11-
let temp = document.createElement('template');
12-
temp.innerHTML = html;
13-
return temp.content.childNodes;
10+
const temp = document.createElement('template')
11+
temp.innerHTML = html
12+
return temp.content.childNodes
1413
}
1514

1615
const find = (selector, elem) => {
17-
if (!elem) {
18-
elem = document;
19-
}
20-
return elem.querySelector(selector);
21-
};
16+
if (!elem) {
17+
elem = document
18+
}
19+
return elem.querySelector(selector)
20+
}
2221

2322
const findAll = (selector, elem) => {
24-
if (!elem) {
25-
elem = document;
26-
}
27-
return [...elem.querySelectorAll(selector)];
28-
};
23+
if (!elem) {
24+
elem = document
25+
}
26+
return [...elem.querySelectorAll(selector)]
27+
}
2928

3029
const insertAdditionalHTML = (html, element, selector) => {
31-
Object.keys(html).map((key) => {
32-
element.querySelectorAll(selector).item(key).insertAdjacentHTML('beforebegin', html[key]);
33-
});
34-
};
30+
Object.keys(html).map((key) => {
31+
element.querySelectorAll(selector).item(key).insertAdjacentHTML('beforebegin', html[key])
32+
})
33+
}
3534

3635
const dom = {
37-
getStaticRow: (key, value) => {
38-
const envRow = templateEnvRow.content.cloneNode(true);
39-
const isObj = typeof value === 'object' && value !== null;
40-
const values = isObj
41-
? Object.keys(value).map((k) => `${k}: ${value[k]}`)
42-
: null;
43-
44-
const valuesElement = htmlToElements(
45-
values
46-
? `<ul>${values.map((val) => `<li>${val}</li>`).join('')}<ul>`
47-
: `<div>${value}</div>`
48-
)[0];
49-
var td = findAll('td', envRow);
50-
td[0].textContent = key;
51-
td[1].appendChild(valuesElement);
52-
53-
return envRow;
54-
},
55-
getListHeader: ({resultsTableHeader}) => {
56-
const header = listHeader.content.cloneNode(true);
57-
const sortAttr = localStorage.getItem('sort');
58-
const sortAsc = JSON.parse(localStorage.getItem('sortAsc'));
59-
const sortables = ['outcome', 'nodeid', 'duration'];
60-
61-
sortables.forEach((sortCol) => {
62-
if (sortCol === sortAttr) {
63-
header.querySelector(`[data-column-type="${sortCol}"]`).classList.add(
64-
sortAsc ? 'desc' : 'asc'
65-
);
66-
}
67-
});
68-
69-
// Add custom html from the pytest_html_results_table_header hook
70-
insertAdditionalHTML(resultsTableHeader, header, 'th');
71-
72-
return header;
73-
},
74-
getListHeaderEmpty: () => listHeaderEmpty.content.cloneNode(true),
75-
getResultTBody: ({ nodeid, longrepr, duration, extras, resultsTableRow, tableHtml }, outcome) => {
76-
const outcomeLower = outcome.toLowerCase();
77-
const resultBody = templateResult.content.cloneNode(true);
78-
resultBody.querySelector('tbody').classList.add(outcomeLower);
79-
resultBody.querySelector('.col-result').innerText = outcome;
80-
resultBody.querySelector('.col-name').innerText = nodeid;
81-
resultBody.querySelector('.col-duration').innerText = `${formatDuration(duration)}s`;
82-
if (['failed', 'error', 'skipped', 'xfailed', 'xpassed'].includes(outcomeLower)) {
83-
resultBody.querySelector('.log').innerText = longrepr
84-
? longrepr.reprtraceback.reprentries[0].data.lines.join('\n')
85-
: '';
86-
} else {
87-
resultBody.querySelector('.extras-row').classList.add('hidden');
88-
}
89-
const images = []
90-
extras &&
91-
extras.forEach(({ name, format_type, content }) => {
92-
const extraLink = aTag.content.cloneNode(true);
93-
const extraLinkItem = extraLink.querySelector('a');
94-
const folderItems = ['image', 'video', 'text', 'html', 'json'];
95-
96-
extraLinkItem.href = content;
97-
extraLinkItem.className = `col-links__extra ${format_type}`;
98-
extraLinkItem.innerText = name;
99-
resultBody.querySelector('.col-links').appendChild(extraLinkItem);
100-
101-
if (format_type === 'image') {
102-
images.push({path: content, name})
36+
getStaticRow: (key, value) => {
37+
const envRow = templateEnvRow.content.cloneNode(true)
38+
const isObj = typeof value === 'object' && value !== null
39+
const values = isObj ? Object.keys(value).map((k) => `${k}: ${value[k]}`) : null
40+
41+
const valuesElement = htmlToElements(
42+
values ? `<ul>${values.map((val) => `<li>${val}</li>`).join('')}<ul>` : `<div>${value}</div>`)[0]
43+
const td = findAll('td', envRow)
44+
td[0].textContent = key
45+
td[1].appendChild(valuesElement)
46+
47+
return envRow
48+
},
49+
getListHeader: ({ resultsTableHeader }) => {
50+
const header = listHeader.content.cloneNode(true)
51+
const sortAttr = localStorage.getItem('sort')
52+
const sortAsc = JSON.parse(localStorage.getItem('sortAsc'))
53+
const sortables = ['outcome', 'nodeid', 'duration']
54+
55+
sortables.forEach((sortCol) => {
56+
if (sortCol === sortAttr) {
57+
header.querySelector(`[data-column-type="${sortCol}"]`).classList.add(sortAsc ? 'desc' : 'asc')
58+
}
59+
})
60+
61+
// Add custom html from the pytest_html_results_table_header hook
62+
insertAdditionalHTML(resultsTableHeader, header, 'th')
63+
64+
return header
65+
},
66+
getListHeaderEmpty: () => listHeaderEmpty.content.cloneNode(true),
67+
getResultTBody: ({ nodeid, longrepr, duration, extras, resultsTableRow, tableHtml }, outcome) => {
68+
const outcomeLower = outcome.toLowerCase()
69+
const resultBody = templateResult.content.cloneNode(true)
70+
resultBody.querySelector('tbody').classList.add(outcomeLower)
71+
resultBody.querySelector('.col-result').innerText = outcome
72+
resultBody.querySelector('.col-name').innerText = nodeid
73+
resultBody.querySelector('.col-duration').innerText = `${formatDuration(duration)}s`
74+
if (['failed', 'error', 'skipped', 'xfailed', 'xpassed'].includes(outcomeLower)) {
75+
resultBody.querySelector('.log').innerText = longrepr ?
76+
longrepr.reprtraceback.reprentries[0].data.lines.join('\n') : ''
77+
} else {
78+
resultBody.querySelector('.extras-row').classList.add('hidden')
10379
}
104-
});
105-
imgViewer.setupImgViewer(resultBody, images)
106-
107-
// Add custom html from the pytest_html_results_table_row hook
108-
resultsTableRow &&
109-
insertAdditionalHTML(resultsTableRow, resultBody, 'td');
110-
111-
// Add custom html from the pytest_html_results_table_html hook
112-
tableHtml &&
113-
tableHtml.forEach((item) => {
114-
resultBody.querySelector('td[class="extra"]').insertAdjacentHTML('beforeend', item);
115-
});
116-
117-
return resultBody;
118-
},
119-
};
80+
const images = []
81+
extras?.forEach(({ name, format_type, content }) => {
82+
const extraLink = aTag.content.cloneNode(true)
83+
const extraLinkItem = extraLink.querySelector('a')
84+
85+
extraLinkItem.href = content
86+
extraLinkItem.className = `col-links__extra ${format_type}`
87+
extraLinkItem.innerText = name
88+
resultBody.querySelector('.col-links').appendChild(extraLinkItem)
89+
90+
if (format_type === 'image') {
91+
images.push({ path: content, name })
92+
}
93+
})
94+
imgViewer.setupImgViewer(resultBody, images)
95+
96+
// Add custom html from the pytest_html_results_table_row hook
97+
resultsTableRow && insertAdditionalHTML(resultsTableRow, resultBody, 'td')
98+
99+
// Add custom html from the pytest_html_results_table_html hook
100+
tableHtml?.forEach((item) => {
101+
resultBody.querySelector('td[class="extra"]').insertAdjacentHTML('beforeend', item)
102+
})
103+
104+
return resultBody
105+
},
106+
}
120107

121108
exports.dom = dom
122109
exports.htmlToElements = htmlToElements

0 commit comments

Comments
 (0)