Skip to content

Query params #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/pytest_html/scripts/datamanager.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
const { getCollapsedCategory } = require('./storage.js')

class DataManager {
setManager(data) {
const collapsedCategories = getCollapsedCategory()
const dataBlob = { ...data, tests: data.tests.map((test, index) => ({
...test,
id: `test_${index}`,
collapsed: false,
collapsed: collapsedCategories.includes(test.outcome.toLowerCase()),
})) }
this.data = { ...dataBlob }
this.renderData = { ...dataBlob }
}

get allData() {
return { ...this.data }
}
Expand Down
19 changes: 8 additions & 11 deletions src/pytest_html/scripts/filter.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,23 @@ const { manager } = require('./datamanager.js')
const storageModule = require('./storage.js')

const getFilteredSubSet = (filter) =>
manager.allData.tests.filter(({ outcome }) => !filter.includes(outcome.toLowerCase()))
manager.allData.tests.filter(({ outcome }) => filter.includes(outcome.toLowerCase()))

const doInitFilter = () => {
const currentFilter = storageModule.getFilter()
const currentFilter = storageModule.getVisible()
const filteredSubset = getFilteredSubSet(currentFilter)
manager.setRender(filteredSubset)
}

const doFilter = (type, apply) => {
const currentFilter = storageModule.getFilter()
if (!apply) {
currentFilter.push(type)
const doFilter = (type, show) => {
if (show) {
storageModule.showCategory(type)
} else {
const index = currentFilter.indexOf(type)
if (index > -1) {
currentFilter.splice(index, 1)
}
storageModule.hideCategory(type)
}

storageModule.setFilter(currentFilter)
const currentFilter = storageModule.getVisible()

if (currentFilter.length) {
const filteredSubset = getFilteredSubSet(currentFilter)
manager.setRender(filteredSubset)
Expand Down
6 changes: 3 additions & 3 deletions src/pytest_html/scripts/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const { dom, findAll } = require('./dom.js')
const { manager } = require('./datamanager.js')
const { doSort } = require('./sort.js')
const { doFilter } = require('./filter.js')
const { getFilter } = require('./storage.js')
const { getVisible } = require('./storage.js')

const removeChildren = (node) => {
while (node.firstChild) {
Expand Down Expand Up @@ -74,14 +74,14 @@ const renderDerived = (tests, collectedItems, isFinished) => {
{ outcome: 'rerun', label: 'Reruns' },
]

const currentFilter = getFilter()
const currentFilter = getVisible()
possibleOutcomes.forEach(({ outcome, label }) => {
const count = renderSet.filter((test) => test.outcome.toLowerCase() === outcome).length
const input = document.querySelector(`input[data-test-result="${outcome}"]`)
document.querySelector(`.${outcome}`).innerText = `${count} ${label}`

input.disabled = !count
input.checked = !currentFilter.includes(outcome)
input.checked = currentFilter.includes(outcome)
})

const numberOfTests = renderSet.filter(({ outcome }) =>
Expand Down
65 changes: 57 additions & 8 deletions src/pytest_html/scripts/storage.js
Original file line number Diff line number Diff line change
@@ -1,22 +1,71 @@
const getFilter = () => [...new Set(JSON.parse(sessionStorage.getItem('filter')))]
const possibleFiltes = ['passed', 'skipped', 'failed', 'error', 'xfailed', 'xpassed', 'rerun']

const getVisible = () => {
const url = new URL(window.location.href)
const settings = new URLSearchParams(url.search).get('visible') || ''
const toret = settings ?
[...new Set(settings.split(',').filter((filter) => possibleFiltes.includes(filter)))] : possibleFiltes

return toret
}
const hideCategory = (categoryToHide) => {
const url = new URL(window.location.href)
const visibleParams = new URLSearchParams(url.search).get('visible')
const currentVisible = visibleParams ? visibleParams.split(',') : [...possibleFiltes]
const settings = [...new Set(currentVisible)].filter((f) => f !== categoryToHide).join(',')

url.searchParams.set('visible', settings)
history.pushState({}, null, unescape(url.href))
}

const showCategory = (categoryToShow) => {
const url = new URL(window.location.href)
const currentVisible = new URLSearchParams(url.search).get('visible')?.split(',') || [...possibleFiltes]
const settings = [...new Set([categoryToShow, ...currentVisible])]
const noFilter = possibleFiltes.length === settings.length || !settings.length

noFilter ? url.searchParams.delete('visible') : url.searchParams.set('visible', settings.join(','))
history.pushState({}, null, unescape(url.href))
}
const setFilter = (currentFilter) => {
sessionStorage.setItem('filter', JSON.stringify(currentFilter))
if (!possibleFiltes.includes(currentFilter)) {
return
}
const url = new URL(window.location.href)
const settings = [currentFilter, ...new Set(new URLSearchParams(url.search).get('filter').split(','))]

url.searchParams.set('filter', settings)
history.pushState({}, null, unescape(url.href))
}

const getSort = () => sessionStorage.getItem('sort')
const setSort = (type) => sessionStorage.setItem('sort', type)
const getSort = () => {
const url = new URL(window.location.href)
return new URLSearchParams(url.search).get('sort') || 'outcome'
}
const setSort = (type) => {
const url = new URL(window.location.href)
url.searchParams.set('sort', type)
history.pushState({}, null, unescape(url.href))
}

const getCollapsedCategory = () => {
const url = new URL(window.location.href)
const collapsedItems = new URLSearchParams(url.search).get('collapsed')
return collapsedItems?.split(',') || []
}

const getSortDirection = () => JSON.parse(sessionStorage.getItem('sortAsc'))

const setSortDirection = (ascending) => {
sessionStorage.setItem('sortAsc', ascending)
}
const setSortDirection = (ascending) => sessionStorage.setItem('sortAsc', ascending)

module.exports = {
getFilter,
getVisible,
setFilter,
hideCategory,
showCategory,
getSort,
getSortDirection,
setSort,
setSortDirection,
getCollapsedCategory,
}
8 changes: 4 additions & 4 deletions testing/unittest.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ describe('Filter tests', () => {
after(() => dataModule.manager.setManager({ tests: [] }))
describe('doInitFilter', () => {
it('has no stored filters', () => {
getFilterMock = sinon.stub(storageModule, 'getFilter').returns([])
getFilterMock = sinon.stub(storageModule, 'getVisible').returns([])
managerSpy = sinon.spy(dataModule.manager, 'setRender')

doInitFilter()
Expand All @@ -55,7 +55,7 @@ describe('Filter tests', () => {
])
})
it('exclude passed', () => {
getFilterMock = sinon.stub(storageModule, 'getFilter').returns(['passed'])
getFilterMock = sinon.stub(storageModule, 'getVisible').returns(['passed'])
managerSpy = sinon.spy(dataModule.manager, 'setRender')

doInitFilter()
Expand All @@ -67,7 +67,7 @@ describe('Filter tests', () => {
let setFilterMock
afterEach(() => setFilterMock.restore())
it('removes a filter', () => {
getFilterMock = sinon.stub(storageModule, 'getFilter').returns(['passed'])
getFilterMock = sinon.stub(storageModule, 'getVisible').returns(['passed'])
setFilterMock = sinon.stub(storageModule, 'setFilter')
managerSpy = sinon.spy(dataModule.manager, 'setRender')

Expand All @@ -78,7 +78,7 @@ describe('Filter tests', () => {
])
})
it('applies a filter', () => {
getFilterMock = sinon.stub(storageModule, 'getFilter').returns([])
getFilterMock = sinon.stub(storageModule, 'getVisible').returns([])
setFilterMock = sinon.stub(storageModule, 'setFilter')
managerSpy = sinon.spy(dataModule.manager, 'setRender')

Expand Down