Class: Google::Apis::TestingV1::TestingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/testing_v1/service.rb

Overview

Cloud Testing API

Allows developers to run automated tests for their mobile applications on Google infrastructure.

Examples:

require 'google/apis/testing_v1'

Testing = Google::Apis::TestingV1 # Alias the module
service = Testing::TestingService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ TestingService

Returns a new instance of TestingService.



46
47
48
49
50
51
 
# File 'lib/google/apis/testing_v1/service.rb', line 46

def initialize
  super('https://testing.googleapis.com/', '',
        client_name: 'google-apis-testing_v1',
        client_version: Google::Apis::TestingV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
 
# File 'lib/google/apis/testing_v1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



44
45
46
 
# File 'lib/google/apis/testing_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#cancel_project_test_matrix(project_id, test_matrix_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TestingV1::CancelTestMatrixResponse

Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asynchronously. If the matrix is already final, this operation will have no effect. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist

Parameters:

  • project_id (String) —

    Cloud project that owns the test.

  • test_matrix_id (String) —

    Test matrix that will be canceled.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/apis/testing_v1/service.rb', line 110

def cancel_project_test_matrix(project_id, test_matrix_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel', options)
  command.response_representation = Google::Apis::TestingV1::CancelTestMatrixResponse::Representation
  command.response_class = Google::Apis::TestingV1::CancelTestMatrixResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['testMatrixId'] = test_matrix_id unless test_matrix_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_test_matrix(project_id, test_matrix_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TestingV1::TestMatrix

Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. A test matrix is limited to use at most 2000 devices in parallel. The returned matrix will not yet contain the executions that will be created for this matrix. That happens later on and will require a call to GetTestMatrix. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed or if the matrix tries to use too many simultaneous devices.

Parameters:

  • project_id (String) —

    The GCE project under which this job will run.

  • test_matrix_object (Google::Apis::TestingV1::TestMatrix) (defaults to: nil)
  • request_id (String) (defaults to: nil) —

    A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/google/apis/testing_v1/service.rb', line 153

def create_project_test_matrix(project_id, test_matrix_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/projects/{projectId}/testMatrices', options)
  command.request_representation = Google::Apis::TestingV1::TestMatrix::Representation
  command.request_object = test_matrix_object
  command.response_representation = Google::Apis::TestingV1::TestMatrix::Representation
  command.response_class = Google::Apis::TestingV1::TestMatrix
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_application_detail_service_apk_details(file_reference_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TestingV1::GetApkDetailsResponse

Gets the details of an Android application APK.

Parameters:

  • file_reference_object (Google::Apis::TestingV1::FileReference) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/google/apis/testing_v1/service.rb', line 72

def get_application_detail_service_apk_details(file_reference_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/applicationDetailService/getApkDetails', options)
  command.request_representation = Google::Apis::TestingV1::FileReference::Representation
  command.request_object = file_reference_object
  command.response_representation = Google::Apis::TestingV1::GetApkDetailsResponse::Representation
  command.response_class = Google::Apis::TestingV1::GetApkDetailsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_test_matrix(project_id, test_matrix_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TestingV1::TestMatrix

Checks the status of a test matrix and the executions once they are created. The test matrix will contain the list of test executions to run if and only if the resultStorage.toolResultsExecution fields have been populated. Note: Flaky test executions may still be added to the matrix at a later stage. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist

Parameters:

  • project_id (String) —

    Cloud project that owns the test matrix.

  • test_matrix_id (String) —

    Unique test matrix id which was assigned by the service.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/google/apis/testing_v1/service.rb', line 194

def get_project_test_matrix(project_id, test_matrix_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/projects/{projectId}/testMatrices/{testMatrixId}', options)
  command.response_representation = Google::Apis::TestingV1::TestMatrix::Representation
  command.response_class = Google::Apis::TestingV1::TestMatrix
  command.params['projectId'] = project_id unless project_id.nil?
  command.params['testMatrixId'] = test_matrix_id unless test_matrix_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_test_environment_catalog(environment_type, project_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::TestingV1::TestEnvironmentCatalog

Gets the catalog of supported test environments. May return any of the following canonical error codes: - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the environment type does not exist - INTERNAL - if an internal error occurred

Parameters:

  • environment_type (String) —

    Required. The type of environment that should be listed.

  • project_id (String) (defaults to: nil) —

    For authorization, the cloud project requesting the TestEnvironmentCatalog.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/apis/testing_v1/service.rb', line 230

def get_test_environment_catalog(environment_type, project_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/testEnvironmentCatalog/{environmentType}', options)
  command.response_representation = Google::Apis::TestingV1::TestEnvironmentCatalog::Representation
  command.response_class = Google::Apis::TestingV1::TestEnvironmentCatalog
  command.params['environmentType'] = environment_type unless environment_type.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end