chore: Drill to detail Modal tests #21148

geido · 2022-08-22T13:22:05Z

SUMMARY

This PR adds RTL tests for the drill to detail modal originally implemented in this PR #20728

Related E2E tests: #21187

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N.A.

TESTING INSTRUCTIONS

All the tests should succeed

ADDITIONAL INFORMATION

Has associated issue:
Required feature flags:
Changes UI
Includes DB Migration (follow approval process in SIP-59)
- Migration is atomic, supports rollback & is backwards-compatible
- Confirm DB migration upgrade and downgrade tested
- Runtime estimates and downtime expectations provided
Introduces new feature or API
Removes existing feature or API

codecov · 2022-08-22T13:46:13Z

Codecov Report

Merging #21148 (c42fb64) into master (5f76ac9) will increase coverage by 0.10%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #21148      +/-   ##
==========================================
+ Coverage   66.40%   66.51%   +0.10%     
==========================================
  Files        1783     1783              
  Lines       68087    68087              
  Branches     7261     7261              
==========================================
+ Hits        45215    45288      +73     
+ Misses      21007    20931      -76     
- Partials     1865     1868       +3

Flag	Coverage Δ
hive	`53.11% <ø> (ø)`
javascript	`52.50% <ø> (+0.20%)`	⬆️
mysql	`81.00% <ø> (ø)`
postgres	`81.05% <ø> (ø)`
presto	`53.01% <ø> (ø)`
python	`81.53% <ø> (ø)`
sqlite	`79.57% <ø> (ø)`
unit	`50.67% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...dashboard/components/SliceHeaderControls/index.tsx	`70.21% <0.00%> (+1.06%)`	⬆️
...erset-frontend/src/components/Chart/chartAction.js	`56.77% <0.00%> (+1.29%)`	⬆️
...frontend/src/components/Chart/DrillDetailModal.tsx	`100.00% <0.00%> (+17.64%)`	⬆️
.../src/dashboard/components/DrillDetailPane/utils.ts	`57.14% <0.00%> (+57.14%)`	⬆️
...ard/components/DrillDetailPane/DrillDetailPane.tsx	`82.75% <0.00%> (+81.03%)`	⬆️
...board/components/DrillDetailPane/TableControls.tsx	`94.11% <0.00%> (+94.11%)`	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

…e/drill-to-detail-modal-tests

github-actions · 2022-08-24T19:53:32Z

Storybook has completed and can be viewed at

kgabryje · 2022-08-25T13:16:43Z

superset-frontend/src/components/Chart/DrillDetailModal.test.tsx

+ });
+};
+const waitForRender = (overrides: Record<string, any> = {}) =>
+ waitFor(() => setup(overrides));


Is it really needed? Don't we always wait for render by default?

@kgabryje in this component there are several async events that would fire warnings during the test runs if we don't wait for the component to be fully loaded. Hence the reason for this.

Oh that's interesting. Does it mean that we should use this pattern in other components too? Maybe this should be a helper function in spec/helpers?

@kgabryje not sure if it is worth creating a function that takes a component and wraps it in a waitFor while also taking eventual overrides but if you think it can help I am happy to create it in a separate PR.

In general, I think there are a lot of reusable helpers that we can create for these RTL tests. This could be an interesting project in order to enforce/suggest certain standards in writing RTL tests. CC @rusackas

Ok, approving this PR 👍 Do you think though that other tests would benefit from using this pattern? Should we use it to decrease the number of warnings?

You can also use findBy in many of these tests if you want to wait for the async operations. findBy is essentially the combination of getBy and waitFor. So this:

test('should render the title', async () => { await waitForRender(); expect( screen.getByText(`Drill to detail: ${chart.form_data.slice_name}`), ).toBeInTheDocument(); });

Could be written as:

test('should render the title', async () => { setup(); expect( await screen.findByText(`Drill to detail: ${chart.form_data.slice_name}`), ).toBeInTheDocument(); });

Either way, the important thing is to account for the async nature of the component as you did.

kgabryje

Lgtm

michael-s-molina

LGTM

superset-frontend/src/dashboard/components/DrillDetailPane/TableControls.test.tsx

…leControls.test.tsx Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com>

github-actions · 2022-08-26T11:24:18Z

Storybook has completed and can be viewed at

github-actions · 2022-08-26T11:44:09Z

Storybook has completed and can be viewed at

github-actions · 2022-08-26T12:28:40Z

Storybook has completed and can be viewed at

github-actions · 2022-08-26T12:39:50Z

Storybook has completed and can be viewed at

github-actions · 2022-08-26T13:27:04Z

Storybook has completed and can be viewed at

…e/drill-to-detail-modal-tests

…m/apache/superset into chore/drill-to-detail-modal-tests

…e/drill-to-detail-modal-tests

geido added 5 commits August 22, 2022 16:15

Add DrillDetailModal test

e9aba99

Add DrillDetailPane tests

af71d5a

Add TableControls test

ed62252

Lint

1e27668

Enhance SliceHeaderControls tests

6806d34

pull-request-size bot added the size/L label Aug 22, 2022

Merge branch 'master' of https://github.com/apache/superset into chor…

cc7840b

…e/drill-to-detail-modal-tests

geido marked this pull request as ready for review August 24, 2022 18:20

geido mentioned this pull request Aug 24, 2022

chore: E2E tests for the Drill to detail modal #21187

Merged

9 tasks

geido requested review from kgabryje, michael-s-molina and rusackas August 24, 2022 18:30

kgabryje reviewed Aug 25, 2022

View reviewed changes

kgabryje approved these changes Aug 25, 2022

View reviewed changes

michael-s-molina approved these changes Aug 25, 2022

View reviewed changes

geido and others added 5 commits August 26, 2022 14:16

Update superset-frontend/src/dashboard/components/DrillDetailPane/Tab…

f071f4c

…leControls.test.tsx Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com>

Update superset-frontend/src/dashboard/components/DrillDetailPane/Tab…

99c29e7

…leControls.test.tsx Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com>

Update superset-frontend/src/dashboard/components/DrillDetailPane/Tab…

70a25a7

…leControls.test.tsx Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com>

Update superset-frontend/src/dashboard/components/DrillDetailPane/Tab…

01a6444

…leControls.test.tsx Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com>

Update superset-frontend/src/dashboard/components/DrillDetailPane/Tab…

ed836b2

…leControls.test.tsx Co-authored-by: Michael S. Molina <70410625+michael-s-molina@users.noreply.github.com>

geido added 3 commits August 26, 2022 16:42

Merge branch 'master' of https://github.com/apache/superset into chor…

a06196c

…e/drill-to-detail-modal-tests

Merge branch 'chore/drill-to-detail-modal-tests' of https://github.co…

d6ca401

…m/apache/superset into chore/drill-to-detail-modal-tests

Merge branch 'master' of https://github.com/apache/superset into chor…

c42fb64

…e/drill-to-detail-modal-tests

geido merged commit 1d3a805 into master Aug 29, 2022

mistercrunch added the 🚢 2.1.3 label Feb 18, 2024

mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 2.1.0 and removed 🚢 2.1.3 labels Mar 13, 2024

mistercrunch deleted the chore/drill-to-detail-modal-tests branch March 26, 2024 16:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Drill to detail Modal tests #21148

chore: Drill to detail Modal tests #21148

geido commented Aug 22, 2022 •

edited

Loading

codecov bot commented Aug 22, 2022 •

edited

Loading

github-actions bot commented Aug 24, 2022

kgabryje Aug 25, 2022

geido Aug 25, 2022 •

edited

Loading

kgabryje Aug 25, 2022

geido Aug 25, 2022

geido Aug 25, 2022 •

edited

Loading

kgabryje Aug 25, 2022

michael-s-molina Aug 25, 2022

kgabryje left a comment

michael-s-molina left a comment

github-actions bot commented Aug 26, 2022

github-actions bot commented Aug 26, 2022

github-actions bot commented Aug 26, 2022

github-actions bot commented Aug 26, 2022

github-actions bot commented Aug 26, 2022

chore: Drill to detail Modal tests #21148

chore: Drill to detail Modal tests #21148

Conversation

geido commented Aug 22, 2022 • edited Loading

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

codecov bot commented Aug 22, 2022 • edited Loading

Codecov Report

github-actions bot commented Aug 24, 2022

kgabryje Aug 25, 2022

Choose a reason for hiding this comment

geido Aug 25, 2022 • edited Loading

Choose a reason for hiding this comment

kgabryje Aug 25, 2022

Choose a reason for hiding this comment

geido Aug 25, 2022

Choose a reason for hiding this comment

geido Aug 25, 2022 • edited Loading

Choose a reason for hiding this comment

kgabryje Aug 25, 2022

Choose a reason for hiding this comment

michael-s-molina Aug 25, 2022

Choose a reason for hiding this comment

kgabryje left a comment

Choose a reason for hiding this comment

michael-s-molina left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 26, 2022

github-actions bot commented Aug 26, 2022

github-actions bot commented Aug 26, 2022

github-actions bot commented Aug 26, 2022

github-actions bot commented Aug 26, 2022

geido commented Aug 22, 2022 •

edited

Loading

codecov bot commented Aug 22, 2022 •

edited

Loading

geido Aug 25, 2022 •

edited

Loading

geido Aug 25, 2022 •

edited

Loading