From 05d6574dfecf640b26b79f09ea6386c45554b274 Mon Sep 17 00:00:00 2001
From: mlasky <mlasky@nuclearhorsestudios.com>
Date: Tue, 9 Jul 2019 20:55:59 -0400
Subject: [PATCH 1/4] logRoles now logs its output to console.

API is unchanged, logRoles will still return the same string, but now
also logs to the console.

https://github.com/testing-library/dom-testing-library/issues/311
---
 src/role-helpers.js | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/role-helpers.js b/src/role-helpers.js
index 5807a206..375909ec 100644
--- a/src/role-helpers.js
+++ b/src/role-helpers.js
@@ -74,7 +74,7 @@ function getRoles(container) {
 function logRoles(container) {
   const roles = getRoles(container)
 
-  return Object.entries(roles)
+  const rolesStr = Object.entries(roles)
     .map(([role, elements]) => {
       const delimiterBar = '-'.repeat(50)
       const elementsString = elements
@@ -84,6 +84,11 @@ function logRoles(container) {
       return `${role}:\n\n${elementsString}\n\n${delimiterBar}`
     })
     .join('\n')
+
+  // eslint-disable-next-line no-console
+  console.log(rolesStr)
+
+  return rolesStr
 }
 
 export {getRoles, logRoles, getImplicitAriaRoles}

From 46d40a30fa3e6216256cef7a34cb604cd87726cd Mon Sep 17 00:00:00 2001
From: mlasky <mlasky@nuclearhorsestudios.com>
Date: Tue, 9 Jul 2019 21:26:44 -0400
Subject: [PATCH 2/4] logRoles no longer returns a string

logRoles now simply calls console.log.
---
 .../__snapshots__/role-helpers.js.snap        | 165 ------------------
 src/__tests__/role-helpers.js                 |  12 +-
 src/role-helpers.js                           |   2 -
 3 files changed, 1 insertion(+), 178 deletions(-)
 delete mode 100644 src/__tests__/__snapshots__/role-helpers.js.snap

diff --git a/src/__tests__/__snapshots__/role-helpers.js.snap b/src/__tests__/__snapshots__/role-helpers.js.snap
deleted file mode 100644
index 16254900..00000000
--- a/src/__tests__/__snapshots__/role-helpers.js.snap
+++ /dev/null
@@ -1,165 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`logRoles logs expected roles for various dom nodes 1`] = `
-"region:
-
-<section
-  data-testid="a-section"
-/>
-
---------------------------------------------------
-navigation:
-
-<nav
-  data-testid="a-nav"
-/>
-
---------------------------------------------------
-heading:
-
-<h1
-  data-testid="a-h1"
-/>
-
-<h2
-  data-testid="a-h2"
-/>
-
-<h3
-  data-testid="a-h3"
-/>
-
---------------------------------------------------
-article:
-
-<article
-  data-testid="a-article"
-/>
-
---------------------------------------------------
-command:
-
-<menuitem
-  data-testid="a-menuitem-1"
-/>
-
-<menuitem
-  data-testid="a-menuitem-2"
-/>
-
---------------------------------------------------
-menuitem:
-
-<menuitem
-  data-testid="a-menuitem-1"
-/>
-
-<menuitem
-  data-testid="a-menuitem-2"
-/>
-
---------------------------------------------------
-list:
-
-<ul
-  data-testid="a-list"
-/>
-
-<ul
-  data-testid="b-list"
-/>
-
---------------------------------------------------
-listitem:
-
-<li
-  data-testid="a-list-item-1"
-/>
-
-<li
-  data-testid="a-list-item-2"
-/>
-
-<li
-  data-testid="b-list-item-1"
-/>
-
-<li
-  data-testid="b-list-item-2"
-/>
-
---------------------------------------------------
-table:
-
-<table
-  data-testid="a-table"
-/>
-
---------------------------------------------------
-rowgroup:
-
-<tbody
-  data-testid="a-tbody"
-/>
-
---------------------------------------------------
-row:
-
-<tr
-  data-testid="a-row"
-/>
-
---------------------------------------------------
-cell:
-
-<td
-  data-testid="a-cell-1"
-/>
-
-<td
-  data-testid="a-cell-2"
-/>
-
-<td
-  data-testid="a-cell-3"
-/>
-
---------------------------------------------------
-form:
-
-<form
-  data-testid="a-form"
-/>
-
---------------------------------------------------
-radio:
-
-<input
-  data-testid="a-radio-1"
-  type="radio"
-/>
-
-<input
-  data-testid="a-radio-2"
-  type="radio"
-/>
-
---------------------------------------------------
-textbox:
-
-<input
-  data-testid="a-input-1"
-  type="text"
-/>
-
-<input
-  data-testid="a-input-2"
-  type="text"
-/>
-
-<textarea
-  data-testid="a-textarea"
-/>
-
---------------------------------------------------"
-`;
diff --git a/src/__tests__/role-helpers.js b/src/__tests__/role-helpers.js
index 4ca15bd1..6364c04d 100644
--- a/src/__tests__/role-helpers.js
+++ b/src/__tests__/role-helpers.js
@@ -1,5 +1,4 @@
-import jestSerializerAnsi from 'jest-serializer-ansi'
-import {getRoles, logRoles, getImplicitAriaRoles} from '../role-helpers'
+import {getRoles, getImplicitAriaRoles} from '../role-helpers'
 import {render, cleanup} from './helpers/test-utils'
 
 afterEach(cleanup)
@@ -132,15 +131,6 @@ test('getRoles returns expected roles for various dom nodes', () => {
   })
 })
 
-test('logRoles logs expected roles for various dom nodes', () => {
-  expect.addSnapshotSerializer(jestSerializerAnsi)
-
-  const {section} = setup()
-  const output = logRoles(section)
-
-  expect(output).toMatchSnapshot()
-})
-
 test('getImplicitAriaRoles returns expected roles for various dom nodes', () => {
   const {section, h1, form, radio, input} = setup()
 
diff --git a/src/role-helpers.js b/src/role-helpers.js
index 375909ec..0c21cb8a 100644
--- a/src/role-helpers.js
+++ b/src/role-helpers.js
@@ -87,8 +87,6 @@ function logRoles(container) {
 
   // eslint-disable-next-line no-console
   console.log(rolesStr)
-
-  return rolesStr
 }
 
 export {getRoles, logRoles, getImplicitAriaRoles}

From d72db4f37279772f1b23cf57454881237e4af624 Mon Sep 17 00:00:00 2001
From: mlasky <mlasky@nuclearhorsestudios.com>
Date: Tue, 9 Jul 2019 21:48:31 -0400
Subject: [PATCH 3/4] Added coverage for logRoles

---
 .../__snapshots__/role-helpers.js.snap        | 165 ++++++++++++++++++
 src/__tests__/role-helpers.js                 |  15 +-
 2 files changed, 179 insertions(+), 1 deletion(-)
 create mode 100644 src/__tests__/__snapshots__/role-helpers.js.snap

diff --git a/src/__tests__/__snapshots__/role-helpers.js.snap b/src/__tests__/__snapshots__/role-helpers.js.snap
new file mode 100644
index 00000000..e31f7a64
--- /dev/null
+++ b/src/__tests__/__snapshots__/role-helpers.js.snap
@@ -0,0 +1,165 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`logRoles calls console.log with output from prettyRoles 1`] = `
+"region:
+
+<section
+  data-testid="a-section"
+/>
+
+--------------------------------------------------
+navigation:
+
+<nav
+  data-testid="a-nav"
+/>
+
+--------------------------------------------------
+heading:
+
+<h1
+  data-testid="a-h1"
+/>
+
+<h2
+  data-testid="a-h2"
+/>
+
+<h3
+  data-testid="a-h3"
+/>
+
+--------------------------------------------------
+article:
+
+<article
+  data-testid="a-article"
+/>
+
+--------------------------------------------------
+command:
+
+<menuitem
+  data-testid="a-menuitem-1"
+/>
+
+<menuitem
+  data-testid="a-menuitem-2"
+/>
+
+--------------------------------------------------
+menuitem:
+
+<menuitem
+  data-testid="a-menuitem-1"
+/>
+
+<menuitem
+  data-testid="a-menuitem-2"
+/>
+
+--------------------------------------------------
+list:
+
+<ul
+  data-testid="a-list"
+/>
+
+<ul
+  data-testid="b-list"
+/>
+
+--------------------------------------------------
+listitem:
+
+<li
+  data-testid="a-list-item-1"
+/>
+
+<li
+  data-testid="a-list-item-2"
+/>
+
+<li
+  data-testid="b-list-item-1"
+/>
+
+<li
+  data-testid="b-list-item-2"
+/>
+
+--------------------------------------------------
+table:
+
+<table
+  data-testid="a-table"
+/>
+
+--------------------------------------------------
+rowgroup:
+
+<tbody
+  data-testid="a-tbody"
+/>
+
+--------------------------------------------------
+row:
+
+<tr
+  data-testid="a-row"
+/>
+
+--------------------------------------------------
+cell:
+
+<td
+  data-testid="a-cell-1"
+/>
+
+<td
+  data-testid="a-cell-2"
+/>
+
+<td
+  data-testid="a-cell-3"
+/>
+
+--------------------------------------------------
+form:
+
+<form
+  data-testid="a-form"
+/>
+
+--------------------------------------------------
+radio:
+
+<input
+  data-testid="a-radio-1"
+  type="radio"
+/>
+
+<input
+  data-testid="a-radio-2"
+  type="radio"
+/>
+
+--------------------------------------------------
+textbox:
+
+<input
+  data-testid="a-input-1"
+  type="text"
+/>
+
+<input
+  data-testid="a-input-2"
+  type="text"
+/>
+
+<textarea
+  data-testid="a-textarea"
+/>
+
+--------------------------------------------------"
+`;
diff --git a/src/__tests__/role-helpers.js b/src/__tests__/role-helpers.js
index 6364c04d..2b4da219 100644
--- a/src/__tests__/role-helpers.js
+++ b/src/__tests__/role-helpers.js
@@ -1,4 +1,5 @@
-import {getRoles, getImplicitAriaRoles} from '../role-helpers'
+import jestSerializerAnsi from 'jest-serializer-ansi'
+import {getRoles, logRoles, getImplicitAriaRoles} from '../role-helpers'
 import {render, cleanup} from './helpers/test-utils'
 
 afterEach(cleanup)
@@ -131,6 +132,18 @@ test('getRoles returns expected roles for various dom nodes', () => {
   })
 })
 
+test('logRoles calls console.log with output from prettyRoles', () => {
+  const {section} = setup()
+  expect.addSnapshotSerializer(jestSerializerAnsi)
+
+  jest.spyOn(console, 'log')
+  logRoles(section)
+  // eslint-disable-next-line no-console
+  expect(console.log.mock.calls).toHaveLength(1)
+  // eslint-disable-next-line no-console
+  expect(console.log.mock.calls[0][0]).toMatchSnapshot()
+})
+
 test('getImplicitAriaRoles returns expected roles for various dom nodes', () => {
   const {section, h1, form, radio, input} = setup()
 

From 5fefa10d167518fa396538a09ef428b81f2ce45d Mon Sep 17 00:00:00 2001
From: mlasky <mlasky@nuclearhorsestudios.com>
Date: Tue, 9 Jul 2019 21:58:39 -0400
Subject: [PATCH 4/4] Fixed logRoles tests, added serializer to test env

Test now only mocks console.log once.

jest-serializer-ansi is now added to tests/setup-env.js so all snapshots
benefit from it.
---
 src/__tests__/role-helpers.js | 9 +++++----
 tests/setup-env.js            | 3 +++
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/src/__tests__/role-helpers.js b/src/__tests__/role-helpers.js
index 2b4da219..ea956ad0 100644
--- a/src/__tests__/role-helpers.js
+++ b/src/__tests__/role-helpers.js
@@ -1,4 +1,3 @@
-import jestSerializerAnsi from 'jest-serializer-ansi'
 import {getRoles, logRoles, getImplicitAriaRoles} from '../role-helpers'
 import {render, cleanup} from './helpers/test-utils'
 
@@ -134,14 +133,16 @@ test('getRoles returns expected roles for various dom nodes', () => {
 
 test('logRoles calls console.log with output from prettyRoles', () => {
   const {section} = setup()
-  expect.addSnapshotSerializer(jestSerializerAnsi)
 
-  jest.spyOn(console, 'log')
+  jest.spyOn(console, 'log').mockImplementationOnce(() => {})
+
   logRoles(section)
   // eslint-disable-next-line no-console
-  expect(console.log.mock.calls).toHaveLength(1)
+  expect(console.log).toHaveBeenCalledTimes(1)
   // eslint-disable-next-line no-console
   expect(console.log.mock.calls[0][0]).toMatchSnapshot()
+  // eslint-disable-next-line no-console
+  console.log.mockRestore()
 })
 
 test('getImplicitAriaRoles returns expected roles for various dom nodes', () => {
diff --git a/tests/setup-env.js b/tests/setup-env.js
index 4435317a..1ced399a 100644
--- a/tests/setup-env.js
+++ b/tests/setup-env.js
@@ -1 +1,4 @@
 import 'jest-dom/extend-expect'
+import jestSerializerAnsi from 'jest-serializer-ansi'
+
+expect.addSnapshotSerializer(jestSerializerAnsi)