[kbn/test] add import/export support to KbnClient by spalger · Pull Request #92526 · elastic/kibana

spalger · 2021-02-23T21:39:43Z

This PR implements a client for using the Saved Objects import and export APIs by writing exports to disk and loading imports from disk into Kibana. This client lives within the KbnClient, and is exposed to the FTR test via the kibanaServer service.

kibanaServer.importExport.save(name, { types, space }) - Save an export of saved objects of listed types (optionally specifying a space) to disk using the given name.
kibanaServer.importExport.load(name, { space }) - Load an export from disk by name into Kibana, optionally into a specific space.
kibanaServer.importExport.unload(name, { space }) - Delete the saved objects from Kibana which share a type and id with objects in the named export on disk.
kibanaServer.savedObjects.clean({ types, space }) - This method is a part of the existing kibanaServer.savedObjects API, but is new and used with the new import/export methods to delete all objects of specific types, optionally specifying something other than the default space

Additionally, node scripts/kbn_archiver exposes the kibanaServer.importExport API for creating/loading/unloading these exports before writing tests. The CLI functions very similarly to node scripts/es_archiver, here is the help text for the CLI:

$ node scripts/kbn_archiver.js --help

  node scripts/kbn_archiver.js [command] [...args]

  Import/export saved objects from archives, for testing

  Commands:
    save <name>
      export saved objects from Kibana to a file

      Options:
        --type             saved object type that should be fetched and stored in the archive, can
                             be specified multiple times or be a comma-separated list.

    load <name>
      import a saved export to Kibana

    unload <name>
      delete the saved objects saved in the archive from the Kibana index


  Global options:
    --space            space id to operate on, defaults to the default space
    --config           optional path to an FTR config file that will be parsed and used for defaults
    --kibana-url       set the url that kibana can be reached at, uses the "servers.kibana" setting from --config by default
    --dir              directory that contains exports to be imported, or where exports will be saved, uses the "kbnArchiver.directory"
                         setting from --config by default
    --verbose, -v      Log verbosely
    --debug            Log debug messages (less than verbose)
    --quiet            Only log errors
    --silent           Don't log anything
    --help             Show this message

Just like node scripts/es_archiver this script takes the --config param which reads an FTR config file to know how to talk to Kibana, including SSL certs and authentication and where the exports are stored on disk for that FTR config.

Thanks to @wayneseymour for getting things started in #90251

Add svc, integrate into one test, add exported saved objects, add empty kibana call, and update ftr schema...add data directory for the new svc.

Make public api take one argument.

Make typescript happier.

…objs-svc

spalger · 2021-02-24T17:50:43Z

I'm expecting we would likely use esArchiver.load('empty_kibana'); before loading SOs or as a cleanup step since the SO API doesn't really make that easy. Any problem with that?

Using the esArchiver to load an empty Kibana index requires that we recreate the index from scratch, including running migrations, which is time intensive and requires that the Kibana server works at some level with the Kibana index disappearing randomly. If we can get away from this I think it would be ideal.

In most cases I expect that we can use kibanaServer.savedObjects.clean({ types }) to make sure that saved objects of specific types are removed, so that lists of objects and such are limited just to the saved objects expected by the tests. I think this should work for nearly every testing scenario, do you?

LeeDr · 2021-02-24T17:53:08Z

I'm expecting we would likely use esArchiver.load('empty_kibana'); before loading SOs or as a cleanup step since the SO API doesn't really make that easy. Any problem with that?

Using the esArchiver to load an empty Kibana index requires that we recreate the index from scratch, including running migrations, which is time intensive and requires that the Kibana server works at some level with the Kibana index disappearing randomly. If we can get away from this I think it would be ideal.

In most cases I expect that we can use kibanaServer.savedObjects.clean({ types }) to make sure that saved objects of specific types are removed, so that lists of objects and such are limited just to the saved objects expected by the tests. I think this should work for nearly every testing scenario, do you?

I guess that .clean would work. In most cases it's just index-patterns, searches, visualizations, and dashboards. If we clean those before loading the test set, and clean again in the after method we'll probably be good. I'm OK with trying to move away from using esArchiver for that.

jbudz

Thoughts on include docs similar to esArchiver in https://www.elastic.co/guide/en/kibana/master/development-tests.html?

I'd be interested in guidance on when to use esArchiver vs kbnArchiver and the new workflow expected for running functional tests

spalger · 2021-02-24T19:37:06Z

Thoughts on include docs similar to esArchiver in elastic.co/guide/en/kibana/master/development-tests.html?

👍 I think that's a great idea, will make sure this PR includes the docs before merge.

I'd be interested in guidance on when to use esArchiver vs kbnArchiver and the new workflow expected for running functional tests

The general plan is to migrate all Kibana Saved Objects interactions to the kbnArchiver where possible. Using the esArchiver needs to still work as long as there are scenarios that we can't test using the kbnArchiver, but I imagine we'll need to try migrating all the current .kibana + esArchiver usage to determine if we still need to support .kibana in the esArchiver.

packages/kbn-test/src/kbn_archiver_cli.ts

…er/kibana into implement/kbn-client-import-export

kibanamachine · 2021-02-25T01:05:50Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💔 Build #109211 failed c12a80a
💚 Build #109129 succeeded c5de626
💛 Build #108909 was flaky 89a607e

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

spong

Security Solution changes LGTM! 👍

Co-authored-by: Tre' Seymour <wayne.seymour@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: spalger <spalger@users.noreply.github.com>

kibanamachine · 2021-02-25T23:17:49Z

💚 Backport successful

✅ 7.12 / #92934
✅ 7.x / #92935

Successful backport PRs will be merged automatically after passing CI.

Co-authored-by: Tre' Seymour <wayne.seymour@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: spalger <spalger@users.noreply.github.com> Co-authored-by: Spencer <email@spalger.com> Co-authored-by: Tre' Seymour <wayne.seymour@elastic.co> Co-authored-by: spalger <spalger@users.noreply.github.com>

…bana into task-manager/docs-monitoring * 'task-manager/docs-monitoring' of github.com:gmmorris/kibana: (40 commits) [Security Solution][Case][Bug] Improve case logging (elastic#91924) [Alerts][Doc] Added README documentation for alerts plugin status and framework health checks configuration options. (elastic#92761) Add warning for EQL and Threshold rules if exception list contains value list items (elastic#92914) [Security Solution][Case] Fix subcases bugs on detections and case view (elastic#91836) [APM] Always allow access to Profiling via URL (elastic#92889) [Vega] Allow image loading without CORS policy by changing the default to crossOrigin=null (elastic#91991) skip flaky suite (elastic#92114) [APM] Fix for default fields in correlations view (elastic#91868) (elastic#92090) chore(NA): bump bazelisk to v1.7.5 (elastic#92905) [Maps] fix selecting EMS basemap does not populate input (elastic#92711) API docs (elastic#92827) [kbn/test] add import/export support to KbnClient (elastic#92526) Test fix management scripted field filter functional test and unskip it (elastic#92756) [App Search] Create Curation view/functionality (elastic#92560) [Reporting/Discover] include the document's entire set of fields (elastic#92730) [Fleet] Add new index to fleet for artifacts being served out of fleet-server (elastic#92860) [Alerts][Doc] Added README documentation for API key invalidation configuration options. (elastic#92757) [Discover][docs] Add search for relevance (elastic#90611) [Alerts][Docs] Extended README.md and the user docs with the licensing information. (elastic#92564) [7.12][Telemetry] Security telemetry allowlist fix. (elastic#92850) ...

rudolf · 2021-03-01T19:47:02Z

Closes #89368

wayneseymour and others added 22 commits February 11, 2021 13:22

[QA] Create Saved Objects FTR Svc

5a8150b

Add svc, integrate into one test, add exported saved objects, add empty kibana call, and update ftr schema...add data directory for the new svc.

[QA] Create Saved Objects FTR Svc

b4e6f4a

Make public api take one argument.

[QA] Create Saved Objects FTR Svc

94a0709

Make typescript happier.

Merge branch 'master' into create-saved-objs-svc

317ab11

Merge branch 'master' into create-saved-objs-svc

2acd53e

refactor to import/export APIs on kbnClient

800c310

move KbnClient to @kbn/test, fix CLI, verify successful response

a1e793d

pretty print exports and support --type in save operations

db08fb6

rename methods to load/save

7965aa5

avoid importing types from src

6892174

add unload method

9b2f437

fix kbnArchiver.directory config getter

a739610

add clean() method for deleting objects by type

31fbc10

move clean and bulkDelete to savedObjects client

9dd92c8

Merge branch 'master' of github.com:elastic/kibana into create-saved-…

4f845e9

…objs-svc

pass KbnClientSavedObjects to KbnClientImportExport

346d6fa

Merge branch 'master' of github.com:elastic/kibana into create-saved-…

a729564

…objs-svc

strip sort field from exports

99eba13

rebuild discover export from esArchive

cd6a509

Merge branch 'master' into create-saved-objs-svc

24cc839

Merge branch 'master' into create-saved-objs-svc

8860be5

Merge branch 'master' into create-saved-objs-svc

89a607e

spalger added Team:Operations Kibana-Operations Team v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.12.0 v7.13.0 labels Feb 23, 2021

Merge branch 'master' into implement/kbn-client-import-export

c5de626

spalger marked this pull request as ready for review February 24, 2021 16:46

spalger requested a review from a team as a code owner February 24, 2021 16:46

jbudz reviewed Feb 24, 2021

View reviewed changes

packages/kbn-test/src/kbn_archiver_cli.ts Outdated Show resolved Hide resolved

spalger added 3 commits February 24, 2021 12:46

add other flags to globalFlags config

44372e3

Merge branch 'implement/kbn-client-import-export' of github.com:spalg…

6a70afd

…er/kibana into implement/kbn-client-import-export

remove accidental change

21fe068

spalger force-pushed the implement/kbn-client-import-export branch from b24dbcb to 21fe068 Compare February 24, 2021 20:41

kibanamachine added 2 commits February 24, 2021 15:42

Merge branch 'master' into implement/kbn-client-import-export

c12a80a

Merge branch 'master' into implement/kbn-client-import-export

abaf2b9

jbudz approved these changes Feb 25, 2021

View reviewed changes

spong approved these changes Feb 25, 2021

View reviewed changes

spalger merged commit 0aabc31 into elastic:master Feb 25, 2021

spalger deleted the implement/kbn-client-import-export branch February 25, 2021 23:13

spalger added the auto-backport Deprecated - use backport:version if exact versions are needed label Feb 25, 2021

kibanamachine mentioned this pull request Feb 25, 2021

[7.12] [kbn/test] add import/export support to KbnClient (#92526) #92934

Merged

kibanamachine mentioned this pull request Feb 25, 2021

[7.x] [kbn/test] add import/export support to KbnClient (#92526) #92935

Merged

rudolf mentioned this pull request Mar 1, 2021

switch from esArchiver to saved objects API for .kibana data in functional tests #89368

Closed

rudolf mentioned this pull request Mar 16, 2021

Fix invalid Reporting integration test data #94616

Merged

spalger mentioned this pull request Apr 6, 2021

[QA] Switch discover tests to use kbnarchiver 2ND DRAFT #95667

Closed

rudolf mentioned this pull request Sep 20, 2021

[SOM] Add visibleInManagement option to management metadata #112073

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[kbn/test] add import/export support to KbnClient#92526

[kbn/test] add import/export support to KbnClient#92526
spalger merged 28 commits intoelastic:masterfrom
spalger:implement/kbn-client-import-export

spalger commented Feb 23, 2021 •

edited

Loading

Uh oh!

spalger commented Feb 24, 2021

Uh oh!

LeeDr commented Feb 24, 2021

Uh oh!

jbudz left a comment

Uh oh!

spalger commented Feb 24, 2021

Uh oh!

Uh oh!

kibanamachine commented Feb 25, 2021

Uh oh!

spong left a comment

Uh oh!

kibanamachine commented Feb 25, 2021

Uh oh!

rudolf commented Mar 1, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

Conversation

spalger commented Feb 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

spalger commented Feb 24, 2021

Uh oh!

LeeDr commented Feb 24, 2021

Uh oh!

jbudz left a comment

Choose a reason for hiding this comment

Uh oh!

spalger commented Feb 24, 2021

Uh oh!

Uh oh!

kibanamachine commented Feb 25, 2021

💚 Build Succeeded

Metrics [docs]

History

Uh oh!

spong left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Feb 25, 2021

💚 Backport successful

Uh oh!

rudolf commented Mar 1, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

spalger commented Feb 23, 2021 •

edited

Loading