« Test an integration Pipeline testing »
Elastic Docs ›Integrations Developer Guide ›Test an integration

Asset testing

edit

Asset testing

edit

Elastic Packages define assets to be loaded into Elasticsearch and Kibana. Asset loading tests exercise install a package to ensure that its assets are loaded into Elasticsearch and Kibana as expected.

Conceptual process

edit

Conceptually, running an asset load test involves the following steps:

  1. Build the package.
  2. Deploy Elasticsearch, Kibana, and the Elastic Package Registry (all of which are part of the Elastic Stack). This step takes time, so you should typically do it once as a prerequisite to running asset loading tests on multiple packages.
  3. Install the package.
  4. Use various Kibana and Elasticsearch APIs to confirm that the package assets were loaded into Kibana and Elasticsearch as expected.
  5. Remove the package.

Define an asset loading test

edit

As a package developer, there is no work required to define an asset loading test for your package. All the necessary information is contained in the package files.

Run an asset loading test

edit

First, you must build your package. This step corresponds to step 1 in the Conceptual process section.

Navigate to the root folder of the package, or any sub-folder under it, and run the following command.

elastic-package build

Next, deploy Elasticsearch, Kibana, and the Elastic Package Registry. This step corresponds to step 2 in the Conceptual process section.

elastic-package stack up -d

To view a list of the available options for this command, run elastic-package stack up -h or elastic-package help stack up.

Next, set the environment variables that are required for additional elastic-package commands.

$(elastic-package stack shellinit)

Next, invoke the asset loading test runner. This step corresponds to steps 3 to 5 in the Conceptual process section.

Navigate to the root folder of the package, or any sub-folder under it, and run the following command.

elastic-package test asset

Finally, when all the asset loading tests have completed, bring down the Elastic Stack. This step corresponds to step 4 in the Conceptual process section.

elastic-package stack down
« Test an integration Pipeline testing »