franky/protos/test_plan.proto

// Copyright 2017 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Schema for Franky testplan. See README.md for more detail.

syntax = "proto3";

package franky;

import "actions.proto";

message TestPlan {
  repeated Test test = 1;
}

message Test {
  enum DeviceType {
    UNSET_DEVICE_TYPE = 0;
    PHONE = 1;
    TABLET = 2;
  }

  string description = 1;
  bool disabled = 2; // For tests known to be broken.
  int32 crbug_id = 3; // Bug ID for a disabled test.
  repeated Step step = 4;
  DeviceType device_type = 5;
  // Comma separated Android versions, e.g. '8,10'
  string device_major_versions = 6;
}

message Coordinate {
  float x = 1;
  float y = 2;
}

message Step {
  enum ActionType {
    ALERT = 0;
    ELEMENT = 1;
    INPUT = 2;
    MENU = 3;
    OMNIBOX = 4;
    ONBOARDING = 5;
    SCROLL = 6;
    SETTINGS = 7;
    SYSTEM = 8;
    TAP = 9;
    TIMEOUT = 10;
  }
  enum By {
    UNSET_BY = 0;
    UIAUTOMATION = 1;
    XPATH = 2;
    ID = 3;
    CLASSNAME = 4;
  }

  string description = 1;     // A brief description of the step
  Action action = 2;
  By by = 3;     // The first element of the locator tuple
  string path = 4;            // The second element of the locator tuple
  string value = 5;
  float duration = 6;         // Step duration in seconds (optional)
  Coordinate start_coordinate = 7;
  Coordinate end_coordinate = 8;
  Test.DeviceType device_type = 9;
  // Comma separated Android versions, e.g. '8,10'
  string device_major_versions = 10;
}