Skip to content

Latest commit

 

History

History
144 lines (115 loc) · 4.66 KB

README.md

File metadata and controls

144 lines (115 loc) · 4.66 KB
Raw

Wasmer Integration Tests

Integration tests for validation the Wasmer product stack, in particular the CLI, the backend and Edge.

Running tests

The tests are written in Typescript, and use the deno test runner.

Follow the Deno installation docs to install deno on your system.

  • Run all tests: deno test --allow-all .
  • Run specific test(s), filtered by name: deno test --allow-all --filter <TEST-NAME> .

Use the --parallel flag to run multiple tests in parallel. By default, this will run tests with a concurrency of local CPU cores. You can use the DENO_JOBS environment variable to control the number of parallel tests..

For example: DENO_JOBS=8 deno test --allow-all --parallel .

Test target environment

Tests are executed against a given test environment, and will create apps in a specified namespace.

By default the Wasmer dev backend is used.

The test target can be customized with environment variables.

Defaults:

  • WASMER_NAMESPACE: 'wasmer-integration-tests' The backend namespace to use for the tests. Packages and apps will be created in this namespace.
  • WASMER_REGISTRY: 'https://registry.wasmer.wtf/graphql' URL of the backend.
  • WASMER_TOKEN: The token for the target backend is retrieved from your wasmer config. (~/.wasmer/wasmer.toml) if not specified.
  • WASMER_PATH: Path to the wasmer CLI executable. By default the tests will just use the locally installed version.
  • WASMOPTICON_DIR: Path to a local clone of of the wasix-org/wasmopticon repository. If not specified, tests will either use a local directory if it exists, or clone the repository on demand.
  • EDGE_SERVER: Instead Edge with regular DNS resolution, test a specific Edge server. NOTE: currently not fully working due to deno not fully implementing the required Node.js APIs.

Writing tests

Many tests create an app through the wasmer deploy command, and then validate the app is running correctly on Edge.

Helper code is available to make this flow more convenient.

In particular, the TestEnv helper provides wrappers for executing CLI commands, creating and deploying apps,sending queries to the backend and sending HTTP requests to Edge.

NOTE: You must use the TestEnv helpers to run CLI commands and to send requests to Edge to ensure test environment settings are respected.

The following code shows an example test with commentary:

// Register a test with the Deno test runner.
Deno.test('app-create-from-package', async () => {
  // Determine the test environment.
  const env = TestEnv.fromEnv();
 
  // An app definition is a structured object that describes app configration
  // with an optional package definition.
  // This can be created and deployed with TestEnv.deployApp().
  const spec: AppDefinition = {
    // app.yaml config.
    appYaml: {
      kind: 'wasmer.io/App.v0',
      name: randomAppName(),
      package: '.',
    },

    // Package definition (wasmer.toml)
    wasmerToml: {
      dependencies: {
        "wasmer/static-web-server": "1",
      },
      fs: {
        "/public": "public",
        // "/settings": "settings",
      },
      command: [{
        name: "script",
        module: "wasmer/static-web-server:webserver",
        runner: "https://webc.org/runner/wasi",
      }],
    },

    // Files that should be present in the package.
    files: {
      'public': {
        'index.html': `<html><body>Hello!</body></html>`,
      },
    }
  };


  // Create a directory with the package contents and app.yaml.
  // Then use the `wasmer deploy` command to deploy the app.
  const info = await env.deployApp(spec);

  // Send an HTTP request to the app running on Edge
  // `fetchApp` is the same as the regular Javascript `fetch()`, but it
  // ensures that requests are sent to the right target.
  const res = await env.fetchApp(info, '/', {headers: {...})
  const body = await res.text();

  // Assert that the response is as expected.
  assertEquals(res.status, 200);
  assertEquals(body.trim(), '<html><body>Hello!</body></html>');

  // NOTE: you can use a full url instead of a path as well, in which case
  // the wrapper will make sure the request is sent to the Edge target server
  // if EDGE_SERVER is specified.
  const res = await env.fetchApp(info, 'https://....', {headers: {...})

  // You can also run custom wasmer CLI commands like this:
  // This will throw an exception if the command fails.
  const output = await env.runWasmerCommand({
    args: [...],
    // Use the app directory as the working directory.
    cwd: info.dir
    env: {...},
  });
  assertEquals(output.stdout, 'my stdout...');
  assertEquals(output.stderr, 'my stderr');
});