Skip to content

Fix toHaveStyle not to return true when shouldn't #81

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 2 commits into from
Oct 9, 2019
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
9 changes: 9 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,15 @@
"name": "Jean Chung",
"avatar_url": "https://avatars0.githubusercontent.com/u/10778036?v=4",
"profile": "https://github.com/jeanchung",
"contributions": [
"code",
"test"
],
{
"login": "CarlaTeo",
"name": "CarlaTeo",
"avatar_url": "https://avatars3.githubusercontent.com/u/9220147?v=4",
"profile": "https://github.com/CarlaTeo",
"contributions": [
"code",
"test"
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
[![version][version-badge]][package] [![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]

[![All Contributors](https://img.shields.io/badge/all_contributors-27-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-28-orange.svg?style=flat-square)](#contributors-)
[![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc]

[![Watch on GitHub][github-watch-badge]][github-watch]
Expand Down Expand Up @@ -1075,6 +1075,7 @@ Thanks goes to these people ([emoji key][emojis]):
</tr>
<tr>
<td align="center"><a href="http://jagascript.com"><img src="https://avatars0.githubusercontent.com/u/4562878?v=4" width="100px;" alt="Jaga Santagostino"/><br /><sub><b>Jaga Santagostino</b></sub></a><br /><a href="https://github.com/testing-library/jest-dom/issues?q=author%3Akandros" title="Bug reports">🐛</a> <a href="https://github.com/testing-library/jest-dom/commits?author=kandros" title="Tests">⚠️</a> <a href="https://github.com/testing-library/jest-dom/commits?author=kandros" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/CarlaTeo"><img src="https://avatars2.githubusercontent.com/u/9220147?s=460&v=4" width="100px;" alt="Carla Teodoro"/><br /><sub><b>Carla Teodoro</b></sub></a><br /><a href="https://github.com/testing-library/jest-dom/commits?author=CarlaTeo" title="Code">💻</a> <a href="https://github.com/testing-library/jest-dom/commits?author=CarlaTeo" title="Tests">⚠️</a></td>
</tr>
</table>

Expand Down
38 changes: 38 additions & 0 deletions src/__tests__/to-have-style.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ describe('.toHaveStyle', () => {
background-color: black;
color: white;
float: left;
transition: opacity 0.2s ease-out, top 0.3s cubic-bezier(1.175, 0.885, 0.32, 1.275);
}
`
document.body.appendChild(style)
Expand All @@ -30,6 +31,11 @@ describe('.toHaveStyle', () => {
background-color: blue;
color: white;
`)

expect(container.querySelector('.label')).toHaveStyle(
'transition: opacity 0.2s ease-out, top 0.3s cubic-bezier(1.175, 0.885, 0.32, 1.275)',
)

expect(container.querySelector('.label')).toHaveStyle(
'background-color:blue;color:white',
)
Expand All @@ -53,6 +59,7 @@ describe('.toHaveStyle', () => {
background-color: black;
color: white;
float: left;
transition: opacity 0.2s ease-out, top 0.3s cubic-bezier(1.175, 0.885, 0.32, 1.275);
}
`
document.body.appendChild(style)
Expand All @@ -63,16 +70,24 @@ describe('.toHaveStyle', () => {
'font-weight: bold',
),
).toThrowError()

expect(() =>
expect(container.querySelector('.label')).not.toHaveStyle('color: white'),
).toThrowError()

expect(() =>
expect(container.querySelector('.label')).toHaveStyle(
'transition: all 0.7s ease, width 1.0s cubic-bezier(3, 4, 5, 6);',
),
).toThrowError()

// Make sure the test fails if the css syntax is not valid
expect(() =>
expect(container.querySelector('.label')).not.toHaveStyle(
'font-weight bold',
),
).toThrowError()

expect(() =>
expect(container.querySelector('.label')).toHaveStyle('color white'),
).toThrowError()
Expand All @@ -96,4 +111,27 @@ describe('.toHaveStyle', () => {
`)
expect(queryByTestId('color-example')).toHaveStyle('border: 1px solid #fff')
})

test('handles different color declaration formats', () => {
const {queryByTestId} = render(`
<span data-testid="color-example" style="color: rgba(0, 0, 0, 1); background-color: #000000">Hello World</span>
`)

expect(queryByTestId('color-example')).toHaveStyle('color: #000000')
expect(queryByTestId('color-example')).toHaveStyle(
'background-color: rgba(0, 0, 0, 1)',
)
})

test('handles nonexistent styles', () => {
const {container} = render(`
<div class="label" style="background-color: blue; height: 100%">
Hello World
</div>
`)

expect(container.querySelector('.label')).not.toHaveStyle(
'whatever: anything',
)
})
})
20 changes: 11 additions & 9 deletions src/to-have-style.js
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
import {matcherHint} from 'jest-matcher-utils'
import jestDiff from 'jest-diff'
import chalk from 'chalk'
import {checkHtmlElement, checkValidCSS} from './utils'
import {checkHtmlElement, parseCSS} from './utils'

function getStyleDeclaration(document, css) {
const styles = {}

// The next block is necessary to normalize colors
const copy = document.createElement('div')
copy.style = css
const styles = copy.style
Object.keys(css).forEach(property => {
copy.style[property] = css[property]
styles[property] = copy.style[property]
})

return Array.from(styles).reduce(
(acc, name) => ({...acc, [name]: styles[name]}),
{},
)
return styles
}

function isSubset(styles, computedStyle) {
Expand Down Expand Up @@ -47,10 +49,10 @@ function expectedDiff(expected, computedStyles) {

export function toHaveStyle(htmlElement, css) {
checkHtmlElement(htmlElement, toHaveStyle, this)
checkValidCSS(css, toHaveStyle, this)
const parsedCSS = parseCSS(css, toHaveStyle, this)
const {getComputedStyle} = htmlElement.ownerDocument.defaultView

const expected = getStyleDeclaration(htmlElement.ownerDocument, css)
const expected = getStyleDeclaration(htmlElement.ownerDocument, parsedCSS)
const received = getComputedStyle(htmlElement)

return {
Expand Down
12 changes: 10 additions & 2 deletions src/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ class InvalidCSSError extends Error {
}
}

function checkValidCSS(css, ...args) {
function parseCSS(css, ...args) {
const ast = parse(`selector { ${css} }`, {silent: true}).stylesheet

if (ast.parsingErrors && ast.parsingErrors.length > 0) {
Expand All @@ -93,6 +93,14 @@ function checkValidCSS(css, ...args) {
...args,
)
}

const parsedRules = ast.rules[0].declarations
.filter(d => d.type === 'declaration')
.reduce(
(obj, {property, value}) => Object.assign(obj, {[property]: value}),
{},
)
return parsedRules
}

function display(value) {
Expand Down Expand Up @@ -187,7 +195,7 @@ function compareArraysAsSet(a, b) {
export {
HtmlElementTypeError,
checkHtmlElement,
checkValidCSS,
parseCSS,
deprecate,
getMessage,
matches,
Expand Down