Comment out example tests

leemthompo · Sep 17, 2024 · cf2ae3b · cf2ae3b
1 parent d2efbcd
commit cf2ae3b
Show file tree

Hide file tree

Showing 37 changed files with 245 additions and 1 deletion.
diff --git a/docs/reference/connector/docs/connectors-API-tutorial.asciidoc b/docs/reference/connector/docs/connectors-API-tutorial.asciidoc
@@ -180,6 +180,8 @@ PUT _connector/my-connector-id
   "index_name":  "music",
   "service_type": "postgresql"
 }
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 [TIP]
@@ -245,6 +247,8 @@ POST /_security/api_key
     }
   }
 }
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 You'll need to use the `encoded` value from the response as the `elasticsearch.api_key` in your configuration file.
@@ -306,6 +310,8 @@ The `last_seen` field indicates that the connector successfully connected to {es
 [source, console]
 ----
 GET _connector/my-connector-id
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-tutorial-api-update-connector-configuration]
@@ -344,6 +350,8 @@ PUT _connector/my-connector-id/_configuration
     "tables": "album,artist"
   }
 }
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 [NOTE]
@@ -373,6 +381,8 @@ POST _connector/_sync_job
     "id": "my-connector-id",
     "job_type": "full"
 }
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 To store data in {es}, the connector needs to create an index.
@@ -396,6 +406,8 @@ Run the following API call to check the status of the sync job:
 [source, console]
 ----
 GET _connector/_sync_job?connector_id=my-connector-id&size=1
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 The job document will be updated as the sync progresses, you can check it as often as you'd like to poll for updates.
@@ -407,6 +419,8 @@ Verify that data is present in the `music` index with the following API call:
 [source, console]
 ----
 GET music/_count
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 {es} stores data in documents, which are JSON objects.
@@ -415,6 +429,8 @@ List the individual documents with the following API call:
 [source, console]
 ----
 GET music/_search
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-tutorial-api-troubleshooting]
@@ -425,6 +441,8 @@ Use the following command to inspect the latest sync job's status:
 [source, console]
 ----
 GET _connector/_sync_job?connector_id=my-connector-id&size=1
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 If the connector encountered any errors during the sync, you'll find these in the `error` field.
@@ -437,6 +455,8 @@ To delete the connector and its associated sync jobs run this command:
 [source, console]
 ----
 DELETE _connector/my-connector-id&delete_sync_jobs=true
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 This won't delete the Elasticsearch index that was created by the connector to store the data.
@@ -445,6 +465,8 @@ Delete the `music` index by running the following command:
 [source, console]
 ----
 DELETE music
+// TEST[skip:TODO]
+// NOTCONSOLE
 ----
 
 To remove the PostgreSQL container, run the following commands:

diff --git a/docs/reference/connector/docs/connectors-azure-blob.asciidoc b/docs/reference/connector/docs/connectors-azure-blob.asciidoc
@@ -258,13 +258,15 @@ To perform E2E testing for the Azure Blob Storage connector, run the following c
 [source,shell]
 ----
 $ make ftest NAME=azure_blob_storage
+// NOTCONSOLE
 ----
 
 For faster tests, add the `DATA_SIZE=small` flag:
 
 [source,shell]
 ----
 make ftest NAME=azure_blob_storage DATA_SIZE=small
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-azure-blob-client-known-issues]

diff --git a/docs/reference/connector/docs/connectors-box.asciidoc b/docs/reference/connector/docs/connectors-box.asciidoc
@@ -349,13 +349,15 @@ To perform E2E testing for the Box connector, run the following command:
 [source,shell]
 ----
 $ make ftest NAME=box
+// NOTCONSOLE
 ----
 
 For faster tests, add the `DATA_SIZE=small` flag:
 
 [source,shell]
 ----
 make ftest NAME=box DATA_SIZE=small
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-box-client-known-issues]

diff --git a/docs/reference/connector/docs/connectors-confluence.asciidoc b/docs/reference/connector/docs/connectors-confluence.asciidoc
@@ -170,6 +170,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet.
     "query": "space = DEV"
   }
 ]
+// NOTCONSOLE
 ----
 
 *Example 2*: Queries for indexing data based on `created` and `lastmodified` time.
@@ -184,6 +185,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet.
     "query": "lastmodified < startOfYear()"
   }
 ]
+// NOTCONSOLE
 ----
 
 *Example 3*: Query for indexing only given types in a *Space* with key 'SD'.
@@ -195,6 +197,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet.
     "query": "type in ('page', 'attachment') AND space.key = 'SD'"
   }
 ]
+// NOTCONSOLE
 ----
 
 [NOTE]
@@ -431,6 +434,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet.
     "query": "space = DEV"
   }
 ]
+// NOTCONSOLE
 ----
 
 *Example 2*: Queries for indexing data based on `created` and `lastmodified` time.
@@ -445,6 +449,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet.
     "query": "lastmodified < startOfYear()"
   }
 ]
+// NOTCONSOLE
 ----
 
 *Example 3*: Query for indexing only given types in a *Space* with key 'SD'.
@@ -456,6 +461,7 @@ Advanced sync rules are defined through a source-specific DSL JSON snippet.
     "query": "type in ('page', 'attachment') AND space.key = 'SD'"
   }
 ]
+// NOTCONSOLE
 ----
 
 [NOTE]
@@ -506,13 +512,15 @@ To perform E2E testing for the Confluence connector, run the following command:
 [source,shell]
 ----
 $ make ftest NAME=confluence
+// NOTCONSOLE
 ----
 
 For faster tests, add the `DATA_SIZE=small` flag:
 
 [source,shell]
 ----
 make ftest NAME=confluence DATA_SIZE=small
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-confluence-client-known-issues]

diff --git a/docs/reference/connector/docs/connectors-dropbox.asciidoc b/docs/reference/connector/docs/connectors-dropbox.asciidoc
@@ -88,6 +88,7 @@ An authorization code *can only be used once* to create a refresh token.
 [source,shell]
 ----
 curl -X POST "https://api.dropboxapi.com/oauth2/token?code=<AUTHORIZATION_CODE>&grant_type=authorization_code" -u "<APP_KEY>:<APP_SECRET>"
+// NOTCONSOLE
 ----
 Store the refresh token from the response to be used in the connector configuration.
 +
@@ -201,6 +202,7 @@ We have some examples below for illustration.
     "query": "dropbox"
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-dropbox-sync-rules-advanced-example-2]
@@ -219,6 +221,7 @@ We have some examples below for illustration.
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-dropbox-sync-rules-advanced-example-3]
@@ -241,6 +244,7 @@ We have some examples below for illustration.
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-dropbox-sync-rules-advanced-limitations]
@@ -343,6 +347,7 @@ An authorization code *can only be used once* to create a refresh token.
 [source,shell]
 ----
 curl -X POST "https://api.dropboxapi.com/oauth2/token?code=<AUTHORIZATION_CODE>&grant_type=authorization_code" -u "<APP_KEY>:<APP_SECRET>"
+// NOTCONSOLE
 ----
 Store the refresh token from the response to be used in the connector configuration.
 +
@@ -481,6 +486,7 @@ We have some examples below for illustration.
     "query": "dropbox"
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-dropbox-client-sync-rules-advanced-example-2]
@@ -499,6 +505,7 @@ We have some examples below for illustration.
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-dropbox-client-sync-rules-advanced-example-3]
@@ -521,6 +528,7 @@ We have some examples below for illustration.
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-dropbox-client-sync-rules-advanced-limitations]
@@ -539,13 +547,15 @@ To perform E2E testing for the Dropbox connector, run the following command:
 [source,shell]
 ----
 $ make ftest NAME=dropbox
+// NOTCONSOLE
 ----
 
 For faster tests, add the `DATA_SIZE=small` flag:
 
 [source,shell]
 ----
 make ftest NAME=dropbox DATA_SIZE=small
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-dropbox-client-known-issues]

diff --git a/docs/reference/connector/docs/connectors-github.asciidoc b/docs/reference/connector/docs/connectors-github.asciidoc
@@ -222,6 +222,7 @@ The following sections provide examples of advanced sync rules for this connecto
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-github-sync-rules-advanced-issue-key]
@@ -237,6 +238,7 @@ The following sections provide examples of advanced sync rules for this connecto
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-github-sync-rules-advanced-pr-key]
@@ -252,6 +254,7 @@ The following sections provide examples of advanced sync rules for this connecto
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-github-sync-rules-advanced-issue-query-branch-name]
@@ -269,6 +272,7 @@ The following sections provide examples of advanced sync rules for this connecto
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [NOTE]
@@ -297,6 +301,7 @@ Check the Elasticsearch index for the actual document count.
     "repository": "repo_name"
   }
 ]
+// NOTCONSOLE
 ----
 
 [NOTE]
@@ -557,6 +562,7 @@ The following sections provide examples of advanced sync rules for this connecto
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-github-client-sync-rules-advanced-issue-key]
@@ -572,6 +578,7 @@ The following sections provide examples of advanced sync rules for this connecto
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-github-client-sync-rules-advanced-pr-key]
@@ -587,6 +594,7 @@ The following sections provide examples of advanced sync rules for this connecto
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-github-client-sync-rules-advanced-issue-query-branch-name]
@@ -604,6 +612,7 @@ The following sections provide examples of advanced sync rules for this connecto
     }
   }
 ]
+// NOTCONSOLE
 ----
 
 [NOTE]
@@ -632,6 +641,7 @@ Check the Elasticsearch index for the actual document count.
     "repository": "repo_name"
   }
 ]
+// NOTCONSOLE
 ----
 
 [NOTE]
@@ -658,13 +668,15 @@ To perform E2E testing for the GitHub connector, run the following command:
 [source,shell]
 ----
 $ make ftest NAME=github
+// NOTCONSOLE
 ----
 
 For faster tests, add the `DATA_SIZE=small` flag:
 
 [source,shell]
 ----
 make ftest NAME=github DATA_SIZE=small
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-github-client-known-issues]

diff --git a/docs/reference/connector/docs/connectors-gmail.asciidoc b/docs/reference/connector/docs/connectors-gmail.asciidoc
@@ -142,6 +142,7 @@ For example:
     "from:amy"
   ]
 }
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-gmail-document-level-security]
@@ -323,6 +324,7 @@ For example:
     "from:amy"
   ]
 }
+// NOTCONSOLE
 ----
 
 [discrete#es-connectors-gmail-client-document-level-security]