forked from apache/superset
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: dashboard edit/save errors (apache#10834)
* use conditional operator for lookup * editing dashboard title should update after save * uncomment test * fix json metadata save * json metadata color scheme should overwrite state * test's functionality is no longer applicable * add lastModifiedTime to DashboardInfo
- Loading branch information
Showing
11 changed files
with
647 additions
and
41 deletions.
There are no files selected for viewing
193 changes: 193 additions & 0 deletions
193
superset-frontend/cypress-base/cypress/integration/dashboard/edit_properties.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,193 @@ | ||
/** | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
// eslint-disable-next-line import/no-extraneous-dependencies | ||
import * as ace from 'brace'; | ||
import * as shortid from 'shortid'; | ||
import { WORLD_HEALTH_DASHBOARD } from './dashboard.helper'; | ||
|
||
function selectColorScheme(color: string) { | ||
// open color scheme dropdown | ||
cy.get('.modal-body') | ||
.contains('Color Scheme') | ||
.parents('.ControlHeader') | ||
.next('.Select') | ||
.click() | ||
.then($colorSelect => { | ||
// select a new color scheme | ||
cy.wrap($colorSelect).find(`[data-test="${color}"]`).click(); | ||
}); | ||
} | ||
|
||
function assertMetadata(text: string) { | ||
const regex = new RegExp(text); | ||
cy.get('.modal-body') | ||
.find('#json_metadata') | ||
.should('be.visible') | ||
.then(() => { | ||
const metadata = cy.$$('#json_metadata')[0]; | ||
|
||
// cypress can read this locally, but not in ci | ||
// so we have to use the ace module directly to fetch the value | ||
expect(ace.edit(metadata).getValue()).to.match(regex); | ||
}); | ||
} | ||
|
||
function typeMetadata(text: string) { | ||
cy.get('.modal-body').find('#json_metadata').should('be.visible').type(text); | ||
} | ||
|
||
function openAdvancedProperties() { | ||
return cy | ||
.get('.modal-body') | ||
.contains('Advanced') | ||
.should('be.visible') | ||
.click(); | ||
} | ||
|
||
function openDashboardEditProperties() { | ||
// open dashboard properties edit modal | ||
cy.get('#save-dash-split-button').trigger('click', { force: true }); | ||
cy.get('.dropdown-menu').contains('Edit dashboard properties').click(); | ||
} | ||
|
||
describe('Dashboard edit action', () => { | ||
beforeEach(() => { | ||
cy.server(); | ||
cy.login(); | ||
cy.visit(WORLD_HEALTH_DASHBOARD); | ||
cy.route(`/api/v1/dashboard/1`).as('dashboardGet'); | ||
cy.get('.dashboard-grid', { timeout: 50000 }) | ||
.should('be.visible') // wait for 50 secs to load dashboard | ||
.then(() => { | ||
cy.get('.dashboard-header [data-test=edit-alt]') | ||
.should('be.visible') | ||
.click(); | ||
openDashboardEditProperties(); | ||
}); | ||
}); | ||
|
||
it('should update the title', () => { | ||
const dashboardTitle = `Test dashboard [${shortid.generate()}]`; | ||
|
||
// update title | ||
cy.get('.modal-body') | ||
.should('be.visible') | ||
.contains('Title') | ||
.siblings('input') | ||
.type(`{selectall}{backspace}${dashboardTitle}`); | ||
|
||
// save edit changes | ||
cy.get('.modal-footer') | ||
.contains('Save') | ||
.click() | ||
.then(() => { | ||
// assert that modal edit window has closed | ||
cy.get('.modal-body').should('not.exist'); | ||
|
||
// assert title has been updated | ||
cy.get('.editable-title input').should('have.value', dashboardTitle); | ||
}); | ||
}); | ||
describe('the color picker is changed', () => { | ||
describe('the metadata has a color scheme', () => { | ||
describe('the advanced tab is open', () => { | ||
// TODO test passes locally but not on ci | ||
xit('should overwrite the color scheme', () => { | ||
openAdvancedProperties(); | ||
cy.wait('@dashboardGet').then(() => { | ||
selectColorScheme('d3Category20b'); | ||
assertMetadata('d3Category20b'); | ||
}); | ||
}); | ||
}); | ||
describe('the advanced tab is not open', () => { | ||
// TODO test passes locally but not on ci | ||
xit('should overwrite the color scheme', () => { | ||
selectColorScheme('bnbColors'); | ||
openAdvancedProperties(); | ||
cy.wait('@dashboardGet').then(() => { | ||
assertMetadata('bnbColors'); | ||
}); | ||
}); | ||
}); | ||
}); | ||
}); | ||
describe('a valid colorScheme is entered', () => { | ||
// TODO test passes locally but not on ci | ||
xit('should save json metadata color change to dropdown', () => { | ||
// edit json metadata | ||
openAdvancedProperties().then(() => { | ||
typeMetadata( | ||
'{selectall}{backspace}{{}"color_scheme":"d3Category20"{}}', | ||
); | ||
}); | ||
|
||
// save edit changes | ||
cy.get('.modal-footer') | ||
.contains('Save') | ||
.click() | ||
.then(() => { | ||
// assert that modal edit window has closed | ||
cy.get('.modal-body').should('not.exist'); | ||
|
||
// assert color has been updated | ||
openDashboardEditProperties(); | ||
openAdvancedProperties().then(() => { | ||
assertMetadata('d3Category20'); | ||
}); | ||
cy.get('.color-scheme-container').should( | ||
'have.attr', | ||
'data-test', | ||
'd3Category20', | ||
); | ||
}); | ||
}); | ||
}); | ||
describe('an invalid colorScheme is entered', () => { | ||
// TODO test passes locally but not on ci | ||
xit('should throw an error', () => { | ||
// edit json metadata | ||
openAdvancedProperties().then(() => { | ||
typeMetadata( | ||
'{selectall}{backspace}{{}"color_scheme":"THIS_DOES_NOT_WORK"{}}', | ||
); | ||
}); | ||
|
||
// save edit changes | ||
cy.get('.modal-footer') | ||
.contains('Save') | ||
.click() | ||
.then(() => { | ||
// assert that modal edit window has closed | ||
cy.get('.modal-body') | ||
.contains('A valid color scheme is required') | ||
.should('be.visible'); | ||
}); | ||
|
||
cy.on('uncaught:exception', err => { | ||
expect(err.message).to.include('something about the error'); | ||
|
||
// return false to prevent the error from | ||
// failing this test | ||
return false; | ||
}); | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.