Class: DatadogAPIClient::V2::TestOptimizationAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/test_optimization_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ TestOptimizationAPI

Returns a new instance of TestOptimizationAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/test_optimization_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/test_optimization_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#search_flaky_tests(opts = {}) ⇒ Object

Search flaky tests.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/test_optimization_api.rb', line 29

def search_flaky_tests(opts = {})
  data, _status_code, _headers = search_flaky_tests_with_http_info(opts)
  data
end

#search_flaky_tests_with_http_info(opts = {}) ⇒ Array<(FlakyTestsSearchResponse, Integer, Hash)>

Search flaky tests.

List endpoint returning flaky tests from Flaky Test Management. Results are paginated.

The response includes comprehensive test information including:

  • Test identification and metadata (module, suite, name)

  • Flaky state and categorization

  • First and last flake occurrences (timestamp, branch, commit SHA)

  • Test execution statistics from the last 7 days (failure rate)

  • Pipeline impact metrics (failed pipelines count, total lost time)

  • Complete status change history (optional, ordered from most recent to oldest)

Set include_history to true in the request to receive the status change history for each test. History is disabled by default for better performance.

Results support filtering by various facets including service, environment, repository, branch, and test state.

Parameters:

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

Returns:

  • FlakyTestsSearchResponse data, response status code and response headers



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/datadog_api_client/v2/api/test_optimization_api.rb', line 54

def search_flaky_tests_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.search_flaky_tests".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.search_flaky_tests")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.search_flaky_tests"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TestOptimizationAPI.search_flaky_tests ...'
  end
  # resource path
  local_var_path = '/api/v2/test/flaky-test-management/tests'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])

  # return_type
  return_type = opts[:debug_return_type] || 'FlakyTestsSearchResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :search_flaky_tests,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TestOptimizationAPI#search_flaky_tests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_flaky_tests_with_pagination(opts = {}) {|FlakyTest| ... } ⇒ Object

Search flaky tests.

Provide a paginated version of #search_flaky_tests, returning all items.

To use it you need to use a block: search_flaky_tests_with_pagination { |item| p item }

Yields:



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/datadog_api_client/v2/api/test_optimization_api.rb', line 115

def search_flaky_tests_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "body.data.attributes.page.limit", 10)
    @api_client.set_attribute_from_path(api_version, opts, "body.data.attributes.page.limit", FlakyTestsSearchRequest, page_size)
    while true do
        response = search_flaky_tests(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "body.data.attributes.page.cursor", FlakyTestsSearchRequest, @api_client.get_attribute_from_path(response, "meta.pagination.next_page"))
    end
end

#update_flaky_tests(body, opts = {}) ⇒ Object

Update flaky test states.

See Also:



132
133
134
135
 
# File 'lib/datadog_api_client/v2/api/test_optimization_api.rb', line 132

def update_flaky_tests(body, opts = {})
  data, _status_code, _headers = update_flaky_tests_with_http_info(body, opts)
  data
end

#update_flaky_tests_with_http_info(body, opts = {}) ⇒ Array<(UpdateFlakyTestsResponse, Integer, Hash)>

Update flaky test states.

Update the state of multiple flaky tests in Flaky Test Management.

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • UpdateFlakyTestsResponse data, response status code and response headers



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/datadog_api_client/v2/api/test_optimization_api.rb', line 144

def update_flaky_tests_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_flaky_tests".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_flaky_tests")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_flaky_tests"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TestOptimizationAPI.update_flaky_tests ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TestOptimizationAPI.update_flaky_tests"
  end
  # resource path
  local_var_path = '/api/v2/test/flaky-test-management/tests'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'UpdateFlakyTestsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_flaky_tests,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TestOptimizationAPI#update_flaky_tests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end