scripts/fxtest/lib/test_definition.dart

// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:fxtest/fxtest.dart';
import 'package:meta/meta.dart';
import 'package:path/path.dart' as p;

/// Structured representation of a single entry from `//out/default/tests.json`.
///
/// Contains all the relevant (e.g., we care about here) data from a single
/// test. Also contains an instance of [ExecutionHandle] which is used at
/// test-execution time to reduce ambiguity around low level invocation details.
class TestDefinition {
  final String buildDir;
  final List<String> command;
  final String cpu;
  final String depsFile;
  final String path;
  final String label;
  final String packageUrl;
  final String name;
  final String os;

  final List<String> deviceTypes;
  final List<String> tags;

  ExecutionHandle _executionHandle;
  PackageUrl _parsedUrl;

  TestDefinition({
    @required this.buildDir,
    this.cpu,
    this.command,
    this.depsFile,
    this.deviceTypes,
    this.label,
    this.name,
    this.os,
    this.packageUrl,
    this.path,
    this.tags,
  });

  factory TestDefinition.fromJson({
    Map<String, dynamic> data,
    String buildDir,
  }) {
    Map<String, dynamic> testDetails = data['test'] ?? {};
    return TestDefinition(
      buildDir: buildDir,
      command: List<String>.from(testDetails['command'] ?? []),
      cpu: testDetails['cpu'] ?? '',
      depsFile: testDetails['deps_file'] ?? '',
      label: testDetails['label'] ?? '',
      name: testDetails['name'] ?? '',
      os: testDetails['os'] ?? '',
      packageUrl: testDetails['package_url'] ?? '',
      path: testDetails['path'] ?? '',
    );
  }

  @override
  String toString() => '''<TestDefinition
  cpu: $cpu
  command: ${(command ?? []).join(" ")}
  deps_file: $depsFile
  label: $label
  package_url: $packageUrl
  path: $path
  name: $name
  os: $os
/>''';

  ExecutionHandle get executionHandle {
    return _executionHandle ??= _createExecutionHandle();
  }

  ExecutionHandle _createExecutionHandle() {
    // `command` must be checked before `host`, because `command` is a subset
    // of all `host` tests
    if (command != null && command.isNotEmpty) {
      return ExecutionHandle.command(command.join(' '), os);

      // The order of `component` / `suite` does not currently matter
    } else if (packageUrl != '' && packageUrl != null) {
      // .cmx tests are considered components
      if (packageUrl.endsWith('.cmx')) {
        return ExecutionHandle.component(packageUrl, os);

        // .cm tests are considered suites
      } else if (packageUrl.endsWith('.cm')) {
        return ExecutionHandle.suite(packageUrl, os);
      }

      // Package Urls must end with either ".cmx" or ".cm"
      throw MalformedFuchsiaUrlException(packageUrl);

      // As per above, `host` must be checked after `command`
    } else if (path != '' && path != null) {
      return ExecutionHandle.host(fullPath, os);
    }
    return ExecutionHandle.unsupported();
  }

  /// Destructured version of `packageUrl` - useful when you need a specific
  /// chunk of the `packageUrl`, most commonly, the embedded `packageName`.
  PackageUrl get parsedUrl {
    if (packageUrl == '' || packageUrl == null) {
      return PackageUrl.none();
    }
    return _parsedUrl ??= PackageUrl.fromString(packageUrl);
  }

  String get fullPath => p.join(buildDir, path);
}