Add missing data-test-subj tags for discover plugin (#9049)

* Add data-test-subj for discover Signed-off-by: Anan Zhuang <[email protected]> * fix comment Signed-off-by: Anan Zhuang <[email protected]> --------- Signed-off-by: Anan Zhuang <[email protected]>
opensearch-project · Dec 16, 2024 · f06a478 · f06a478
1 parent 16115ba
commit f06a478
Show file tree

Hide file tree

Showing 24 changed files with 87 additions and 23 deletions.
diff --git a/src/plugins/discover/public/application/components/chart/chart.tsx b/src/plugins/discover/public/application/components/chart/chart.tsx
@@ -72,7 +72,7 @@ export const DiscoverChart = ({
   const [isCollapsed, setIsCollapsed] = useState(false);
 
   const hitsCounter = (
-    <div className="dscChart__hitsCounter">
+    <div className="dscChart__hitsCounter" data-test-subj="dscChartHitsCounter">
       <HitsCounter
         hits={hits > 0 ? hits : 0}
         showResetButton={showResetButton}
@@ -82,7 +82,7 @@ export const DiscoverChart = ({
   );
 
   const timeChartHeader = (
-    <div className="dscChart__TimechartHeader">
+    <div className="dscChart__TimechartHeader" data-test-subj="dscChartTimechartHeader">
       <TimechartHeader
         bucketInterval={bucketInterval}
         dateFormat={config.get('dateFormat')}
@@ -112,7 +112,12 @@ export const DiscoverChart = ({
   );
 
   const queryEnhancedHistogramHeader = (
-    <EuiFlexGroup direction="row" gutterSize="m" className="dscChart__chartheader">
+    <EuiFlexGroup
+      direction="row"
+      gutterSize="m"
+      className="dscChart__chartheader"
+      data-test-subj="dscChartChartheader"
+    >
       <EuiFlexItem grow={false}>{toggle}</EuiFlexItem>
       <EuiFlexItem grow={false}>{hitsCounter}</EuiFlexItem>
       <EuiFlexItem grow={true} style={{ justifyContent: 'flex-start' }}>
@@ -138,6 +143,7 @@ export const DiscoverChart = ({
       direction="column"
       gutterSize="none"
       className={isEnhancementsEnabled ? 'dscChart__wrapper' : ''}
+      data-test-subj="dscChartWrapper"
     >
       {isEnhancementsEnabled ? queryEnhancedHistogramHeader : histogramHeader}
       {isTimeBased && chartData && showHistogram && (
@@ -147,6 +153,7 @@ export const DiscoverChart = ({
               defaultMessage: 'Histogram of found documents',
             })}
             className="dscTimechart"
+            data-test-subj="dscTimechart"
           >
             <div className="dscHistogram" data-test-subj="discoverChart">
               <DiscoverHistogram

diff --git a/src/plugins/discover/public/application/components/chart/histogram/histogram.tsx b/src/plugins/discover/public/application/components/chart/histogram/histogram.tsx
@@ -198,6 +198,7 @@ export class DiscoverHistogram extends Component<DiscoverHistogramProps, Discove
           <EuiFlexGroup
             alignItems="center"
             className="dscHistogram__header--partial"
+            data-test-subj="dscHistogramHeader"
             responsive={false}
             gutterSize="xs"
           >

diff --git a/src/plugins/discover/public/application/components/chart/hits_counter/hits_counter.tsx b/src/plugins/discover/public/application/components/chart/hits_counter/hits_counter.tsx
@@ -55,6 +55,7 @@ export function HitsCounter({ hits, showResetButton, onResetQuery }: HitsCounter
       <EuiFlexGroup
         gutterSize="s"
         className="dscResultCount"
+        data-test-subj="dscResultCount"
         responsive={false}
         justifyContent="center"
         alignItems="center"

diff --git a/...gins/discover/public/application/components/data_grid/data_grid_table_cell_value.test.tsx b/...gins/discover/public/application/components/data_grid/data_grid_table_cell_value.test.tsx
@@ -158,6 +158,7 @@ describe('Testing fetchTableDataCell function', () => {
       >
         <EuiDescriptionListTitle
           className="osdDescriptionListFieldTitle"
+          data-test-subj="dscDataGridTableCellListFieldTitle"
         >
           order_date:
         </EuiDescriptionListTitle>

diff --git a/src/plugins/discover/public/application/components/data_grid/data_grid_table_cell_value.tsx b/src/plugins/discover/public/application/components/data_grid/data_grid_table_cell_value.tsx
@@ -36,7 +36,10 @@ export function fetchSourceTypeDataCell(
     <EuiDescriptionList type="inline" compressed className="source">
       {keys.map((key, index) => (
         <Fragment key={key}>
-          <EuiDescriptionListTitle className="osdDescriptionListFieldTitle">
+          <EuiDescriptionListTitle
+            className="osdDescriptionListFieldTitle"
+            data-test-subj="dscDataGridTableCellListFieldTitle"
+          >
             {key + ':'}
           </EuiDescriptionListTitle>
           <EuiDescriptionListDescription

diff --git a/src/plugins/discover/public/application/components/default_discover_table/pagination.tsx b/src/plugins/discover/public/application/components/default_discover_table/pagination.tsx
@@ -28,7 +28,12 @@ export const Pagination = ({
   sampleSize,
 }: Props) => {
   return (
-    <EuiFlexGroup className="osdDocTable_pagination" alignItems="center" justifyContent="flexEnd">
+    <EuiFlexGroup
+      className="osdDocTable_pagination"
+      alignItems="center"
+      justifyContent="flexEnd"
+      data-test-subj="osdDocTablePagination"
+    >
       {endItem >= sampleSize && (
         <EuiFlexItem grow={false}>
           <EuiTextColor color="subdued">

diff --git a/src/plugins/discover/public/application/components/default_discover_table/table_cell.tsx b/src/plugins/discover/public/application/components/default_discover_table/table_cell.tsx
@@ -36,10 +36,11 @@ const TableCellUI = ({
     <>
       <span
         className="osdDocTableCell__dataField"
+        data-test-subj="osdDocTableCellDataField"
         // eslint-disable-next-line react/no-danger
         dangerouslySetInnerHTML={{ __html: sanitizedCellValue }}
       />
-      <span className="osdDocTableCell__filter">
+      <span className="osdDocTableCell__filter" data-test-subj="osdDocTableCellFilter">
         <EuiToolTip
           content={i18n.translate('discover.filterForValue', {
             defaultMessage: 'Filter for value',

diff --git a/src/plugins/discover/public/application/components/default_discover_table/table_row.tsx b/src/plugins/discover/public/application/components/default_discover_table/table_row.tsx
@@ -141,9 +141,17 @@ const TableRowUI = ({
 
   const expandedTableRow = (
     <tr key={'x' + row._id}>
-      <td className="osdDocTable__detailsParent" colSpan={columns.length + 1}>
+      <td
+        className="osdDocTable__detailsParent"
+        colSpan={columns.length + 1}
+        data-test-subj="osdDocTableDetailsParent"
+      >
         <EuiFlexGroup gutterSize="m" alignItems="center">
-          <EuiFlexItem grow={false} className="osdDocTable__detailsIconContainer">
+          <EuiFlexItem
+            grow={false}
+            className="osdDocTable__detailsIconContainer"
+            data-test-subj="osdDocTableDetailsIconContainer"
+          >
             <EuiIcon type="folderOpen" />
           </EuiFlexItem>
           <EuiFlexItem>

diff --git a/.../discover/public/application/components/doc_viewer/__snapshots__/doc_viewer.test.tsx.snap b/.../discover/public/application/components/doc_viewer/__snapshots__/doc_viewer.test.tsx.snap
diff --git a/src/plugins/discover/public/application/components/doc_viewer/doc_viewer.tsx b/src/plugins/discover/public/application/components/doc_viewer/doc_viewer.tsx
@@ -68,7 +68,7 @@ export function DocViewer(renderProps: DocViewRenderProps) {
   }
 
   return (
-    <div className="osdDocViewer">
+    <div className="osdDocViewer" data-test-subj="osdDocViewer">
       <EuiTabbedContent tabs={tabs} size="s" />
     </div>
   );

diff --git a/src/plugins/discover/public/application/components/doc_views/context_app.tsx b/src/plugins/discover/public/application/components/doc_views/context_app.tsx
@@ -88,7 +88,7 @@ export function ContextApp({
         onChangeCount={onChangeCount}
         type={SurrDocType.PREDECESSORS}
       />
-      <div className="dscDocsGrid">
+      <div className="dscDocsGrid" data-test-subj="dscDocsGrid">
         <DataGridTable
           aria-label={'ContextTable'}
           columns={columns}

diff --git a/src/plugins/discover/public/application/components/doc_views/single_doc_app.tsx b/src/plugins/discover/public/application/components/doc_views/single_doc_app.tsx
@@ -76,7 +76,7 @@ export function SingleDocApp() {
   }
 
   return (
-    <div className="single doc view">
+    <div className="single doc view" data-test-subj="singleDocView">
       <Doc
         id={docId}
         index={index}

diff --git a/src/plugins/discover/public/application/components/doc_views/surrounding_docs_view.tsx b/src/plugins/discover/public/application/components/doc_views/surrounding_docs_view.tsx
@@ -129,8 +129,8 @@ export const SurroundingDocsView = ({ id, indexPattern }: SurroundingDocsViewPar
         indexPatterns={[indexPattern]}
         useDefaultBehaviors={true}
       />
-      <EuiPage className="discover.context.appPage">
-        <EuiPageContent paddingSize="s" className="dscDocsContent">
+      <EuiPage className="discover.context.appPage" data-test-subj="discoverAppPage">
+        <EuiPageContent paddingSize="s" className="dscDocsContent" data-test-subj="dscDocsContent">
           {contextAppMemoized}
         </EuiPageContent>
       </EuiPage>

diff --git a/src/plugins/discover/public/application/components/loading_spinner/loading_spinner.tsx b/src/plugins/discover/public/application/components/loading_spinner/loading_spinner.tsx
@@ -35,7 +35,13 @@ import { FormattedMessage } from '@osd/i18n/react';
 
 export function LoadingSpinner() {
   return (
-    <EuiPanel hasBorder={false} hasShadow={false} color="transparent" className="discoverNoResults">
+    <EuiPanel
+      hasBorder={false}
+      hasShadow={false}
+      color="transparent"
+      className="discoverNoResults"
+      data-test-subj="discoverNoResults"
+    >
       <EuiEmptyPrompt
         icon={<EuiLoadingSpinner data-test-subj="loadingSpinner" size="xl" />}
         title={

diff --git a/src/plugins/discover/public/application/components/no_results/no_results.tsx b/src/plugins/discover/public/application/components/no_results/no_results.tsx
@@ -301,7 +301,10 @@ export const DiscoverNoResults = ({ queryString, query, savedQuery, timeFieldNam
           }
         />
         {tabs.length && (
-          <div className="discoverNoResults-sampleContainer">
+          <div
+            className="discoverNoResults-sampleContainer"
+            data-test-subj="discoverNoResultsSampleContainer"
+          >
             <EuiTabbedContent tabs={tabs} />
           </div>
         )}

diff --git a/src/plugins/discover/public/application/components/sidebar/discover_field.tsx b/src/plugins/discover/public/application/components/sidebar/discover_field.tsx
@@ -198,7 +198,13 @@ export const DiscoverField = ({
   }
 
   return (
-    <EuiFlexGroup gutterSize="s" alignItems="center" responsive={false} className="dscSidebarField">
+    <EuiFlexGroup
+      gutterSize="s"
+      alignItems="center"
+      responsive={false}
+      className="dscSidebarField"
+      data-test-subj="dscSidebarField"
+    >
       <EuiFlexItem grow={false}>
         <FieldIcon
           type={field.type}

diff --git a/src/plugins/discover/public/application/components/sidebar/discover_field_bucket.tsx b/src/plugins/discover/public/application/components/sidebar/discover_field_bucket.tsx
@@ -74,7 +74,11 @@ export function DiscoverFieldBucket({ field, bucket, onAddFilter }: Props) {
   return (
     <>
       <EuiFlexGroup justifyContent="spaceBetween" responsive={false} gutterSize="s">
-        <EuiFlexItem className="dscFieldDetails__barContainer" grow={1}>
+        <EuiFlexItem
+          className="dscFieldDetails__barContainer"
+          grow={1}
+          data-test-subj="dscFieldDetailsBarContainer"
+        >
           <EuiFlexGroup justifyContent="spaceBetween" gutterSize="xs" responsive={false}>
             <EuiFlexItem grow={1} className="eui-textTruncate">
               <EuiText
@@ -85,6 +89,7 @@ export function DiscoverFieldBucket({ field, bucket, onAddFilter }: Props) {
                 }
                 size="xs"
                 className="eui-textTruncate"
+                data-test-subj="dscFieldDetailsText"
               >
                 {bucket.display === '' ? emptyTxt : bucket.display}
               </EuiText>

diff --git a/src/plugins/discover/public/application/components/sidebar/discover_field_data_frame.tsx b/src/plugins/discover/public/application/components/sidebar/discover_field_data_frame.tsx
@@ -21,6 +21,7 @@ export function DiscoverFieldDataFrame({ onCreateIndexPattern, onNormalizeIndexP
           onClick={onNormalizeIndexPattern}
           size="xs"
           className="dscSideBar_normalizeIndexPattern"
+          data-test-subj="dscSideBarNormalizeIndexPatternButton"
         >
           {i18n.translate('discover.fieldChooser.dataFrame.normalizeIndexPattern', {
             defaultMessage: 'Normalize',
@@ -33,6 +34,7 @@ export function DiscoverFieldDataFrame({ onCreateIndexPattern, onNormalizeIndexP
           onClick={onCreateIndexPattern}
           size="xs"
           className="dscSideBar_createIndexPattern"
+          data-test-subj="dscSideBarCreateIndexPatternButton"
         >
           {i18n.translate('discover.fieldChooser.dataFrame.createIndexPattern', {
             defaultMessage: 'Create index pattern',

diff --git a/src/plugins/discover/public/application/components/sidebar/discover_field_search.tsx b/src/plugins/discover/public/application/components/sidebar/discover_field_search.tsx
@@ -315,7 +315,10 @@ export function DiscoverFieldSearch({
 
   if (isEnhancementsEnabledOverride) {
     return (
-      <div className="euiFormControlLayout euiFormControlLayout--compressed euiFormControlLayout--group osdDiscoverSideBar__wrap">
+      <div
+        className="euiFormControlLayout euiFormControlLayout--compressed euiFormControlLayout--group osdDiscoverSideBar__wrap"
+        data-test-subj="osdDiscoverSideBarWrapper"
+      >
         {compressedFieldSearch}
         {fieldPopover}
       </div>

diff --git a/src/plugins/discover/public/application/components/sidebar/discover_sidebar.tsx b/src/plugins/discover/public/application/components/sidebar/discover_sidebar.tsx
@@ -312,6 +312,7 @@ const FieldList = ({
         onClick={() => setExpanded(!expanded)}
         size="xs"
         className="dscSideBar_fieldGroup"
+        data-test-subj="dscSideBarFieldGroupButton"
         aria-label={title}
         isLoading={!!selectedIndexPattern.fieldsLoading}
       >

diff --git a/src/plugins/discover/public/application/components/table/table.tsx b/src/plugins/discover/public/application/components/table/table.tsx
@@ -56,7 +56,7 @@ export function DocViewTable({
   }
 
   return (
-    <table className="table table-condensed osdDocViewerTable">
+    <table className="table table-condensed osdDocViewerTable" data-test-subj="osdDocViewerTable">
       <tbody>
         {Object.keys(flattened)
           .sort()

diff --git a/src/plugins/discover/public/application/components/table/table_row.tsx b/src/plugins/discover/public/application/components/table/table_row.tsx
@@ -81,7 +81,7 @@ export function DocViewTableRow({
   return (
     <tr key={field} data-test-subj={`tableDocViewRow-${field}`}>
       {typeof onFilter === 'function' && (
-        <td className="osdDocViewer__buttons">
+        <td className="osdDocViewer__buttons" data-test-subj="osdDocViewerButtons">
           <DocViewTableRowBtnFilterAdd
             disabled={!fieldMapping || !fieldMapping.filterable}
             onClick={() => onFilter(fieldMapping, valueRaw, '+')}
@@ -100,7 +100,7 @@ export function DocViewTableRow({
           />
         </td>
       )}
-      <td className="osdDocViewer__field">
+      <td className="osdDocViewer__field" data-test-subj="osdDocViewerField">
         <FieldName
           fieldName={field}
           fieldType={fieldType}

diff --git a/src/plugins/discover/public/application/view_components/canvas/index.tsx b/src/plugins/discover/public/application/view_components/canvas/index.tsx
@@ -135,6 +135,7 @@ export default function DiscoverCanvas({ setHeaderActionMenu, history, optionalR
       hasShadow={false}
       paddingSize="s"
       className="dscCanvas"
+      data-test-subj="dscCanvas"
       borderRadius="l"
     >
       <TopNav
@@ -173,7 +174,12 @@ export default function DiscoverCanvas({ setHeaderActionMenu, history, optionalR
                 <MemoizedDiscoverTable rows={rows} scrollToTop={scrollToTop} />
               </>
             ) : (
-              <EuiPanel hasShadow={false} paddingSize="none" className="dscCanvas_results">
+              <EuiPanel
+                hasShadow={false}
+                paddingSize="none"
+                className="dscCanvas_results"
+                data-test-subj="dscCanvasResults"
+              >
                 <MemoizedDiscoverChartContainer {...fetchState} />
                 <MemoizedDiscoverTable rows={rows} scrollToTop={scrollToTop} />
               </EuiPanel>

diff --git a/src/plugins/discover/public/embeddable/search_embeddable_component.tsx b/src/plugins/discover/public/embeddable/search_embeddable_component.tsx
@@ -58,7 +58,11 @@ export function SearchEmbeddableComponent({ searchProps }: SearchEmbeddableProps
           className="eui-xScrollWithShadows eui-yScrollWithShadows"
         >
           {discoverEmbeddableProps.hits !== 0 ? (
-            <EuiFlexItem style={{ minHeight: 0 }} className="osdDocTable__container">
+            <EuiFlexItem
+              style={{ minHeight: 0 }}
+              className="osdDocTable__container"
+              data-test-subj="osdDocTableContainer"
+            >
               <DataGridTableMemoized {...discoverEmbeddableProps} />
             </EuiFlexItem>
           ) : (