DashboardScene - Add various-suite to scenes e2e (#88911)

* duplicate various-suite in scenes e2e * restore original various-suite * adjust various-suite e2e tests for scenes * adjust workflow for test run * adjust flaky exemplars test * remove old dash script and restore workflow * duplicate e2e/various-suite/keybinds.spec.ts into e2e/scenes * restore original e2e/various-suite/keybinds.spec.ts * add new keybinds e2e test * restore workflow file after test run
2024-06-12 11:36:11 +02:00
parent dc03798c34
commit 8d0e437287
26 changed files with 1993 additions and 0 deletions
@@ -0,0 +1,123 @@
+import { e2e } from '../utils';
+import { addDashboard } from '../utils/flows';
+
+import { createPromDS, getResources } from './helpers/prometheus-helpers';
+
+const DATASOURCE_ID = 'Prometheus';
+
+const DATASOURCE_NAME = 'prometheusVariableDS';
+
+/**
+ * Click dashboard settings and then the variables tab
+ */
+function navigateToVariables() {
+  e2e.components.NavToolbar.editDashboard.editButton().should('be.visible').click();
+  e2e.components.NavToolbar.editDashboard.settingsButton().should('be.visible').click();
+  e2e.components.Tab.title('Variables').click();
+}
+
+/**
+ * Begin the process of adding a query type variable for a Prometheus data source
+ *
+ * @param variableName the name of the variable as a label of the variable dropdown
+ */
+function addPrometheusQueryVariable(variableName: string) {
+  e2e.pages.Dashboard.Settings.Variables.List.addVariableCTAV2().click();
+
+  e2e.pages.Dashboard.Settings.Variables.Edit.General.generalNameInputV2().clear().type(variableName);
+  e2e.components.DataSourcePicker.container().should('be.visible').click();
+  cy.contains(DATASOURCE_NAME).scrollIntoView().should('be.visible').click();
+
+  getResources();
+}
+
+/**
+ * Create a Prometheus variable and navigate to the query editor to check that it is available to use.
+ *
+ * @param variableName name the variable
+ * @param queryType query type of 'Label names', 'Label values', 'Metrics', 'Query result', 'Series query' or 'Classic query'. These types should be imported from the Prometheus library eventually but not now because we are in the process of decoupling the DS from core grafana.
+ */
+function variableFlowToQueryEditor(variableName: string, queryType: string) {
+  addDashboard();
+  navigateToVariables();
+  addPrometheusQueryVariable(variableName);
+
+  // select query type
+  e2e.components.DataSource.Prometheus.variableQueryEditor.queryType().click();
+  selectOption(queryType);
+
+  // apply the variable
+  e2e.pages.Dashboard.Settings.Variables.Edit.General.applyButton().click();
+
+  // close to return to dashboard
+  e2e.components.NavToolbar.editDashboard.backToDashboardButton().should('be.visible').click();
+
+  // add visualization
+  e2e.pages.AddDashboard.itemButton('Create new panel button').should('be.visible').click();
+
+  // close the data source picker modal
+  cy.get('[aria-label="Close"]').click();
+
+  // select prom data source from the data source list with the useful data-testid
+  e2e.components.DataSourcePicker.inputV2().click({ force: true }).type(`${DATASOURCE_NAME}{enter}`);
+
+  // confirm the variable exists in the correct input
+  // use the variable query type from the library in the future
+  switch (queryType) {
+    case 'Label names':
+      e2e.components.QueryBuilder.labelSelect().should('exist').click({ force: true });
+      selectOption(`${variableName}`);
+    case 'Label values':
+      e2e.components.QueryBuilder.valueSelect().should('exist').click({ force: true });
+      selectOption(`${variableName}`);
+    case 'Metrics':
+      e2e.components.DataSource.Prometheus.queryEditor.builder.metricSelect().should('exist').click({ force: true });
+      selectOption(`${variableName}`);
+    default:
+    // do nothing
+  }
+}
+
+describe('Prometheus variable query editor', () => {
+  beforeEach(() => {
+    createPromDS(DATASOURCE_ID, DATASOURCE_NAME);
+  });
+
+  it('should navigate to variable query editor', () => {
+    addDashboard();
+    navigateToVariables();
+  });
+
+  it('should select a query type for a Prometheus variable query', () => {
+    addDashboard();
+    navigateToVariables();
+    addPrometheusQueryVariable('labelsVariable');
+
+    // select query type
+    e2e.components.DataSource.Prometheus.variableQueryEditor.queryType().click();
+
+    selectOption('Label names');
+  });
+
+  it('should create a label names variable that is selectable in the label select in query builder', () => {
+    addDashboard();
+    navigateToVariables();
+    variableFlowToQueryEditor('labelnames', 'Label names');
+  });
+
+  it('should create a label values variable that is selectable in the label values select in query builder', () => {
+    addDashboard();
+    navigateToVariables();
+    variableFlowToQueryEditor('labelvalues', 'Label values');
+  });
+
+  it('should create a metric names variable that is selectable in the metric select in query builder', () => {
+    addDashboard();
+    navigateToVariables();
+    variableFlowToQueryEditor('metrics', 'Metrics');
+  });
+});
+
+function selectOption(option: string) {
+  e2e.components.Select.option().contains(option).should('be.visible').click();
+}