Class: AtlasRb::Reset

Inherits:
Object
  • Object
show all
Extended by:
FaradayHelper
Defined in:
lib/atlas_rb.rb

Overview

Test-environment helper that wipes Atlas state via GET /reset.

Do not call against production. This exists so RSpec suites running against a disposable Atlas instance can return to a clean baseline between examples.

Constant Summary

Constants included from FaradayHelper

FaradayHelper::ASSERTION_AUDIENCE, FaradayHelper::ASSERTION_ISSUER, FaradayHelper::ASSERTION_TTL, FaradayHelper::INSTRUMENTATION_EVENT

Class Method Summary collapse

Methods included from FaradayHelper

connection, multipart, read_body, read_raw, system_connection, with_file_part

Class Method Details

.clean(nuid: nil, on_behalf_of: nil) ⇒ String?

Reset the connected Atlas instance to a clean state.

Atlas serves GET /reset with require_auth skipped (it is env-gated, not principal-gated), so this call uses optional auth: it signs an assertion when a credential is available, and sends no Authorization header otherwise — never raising ConfigurationError for lack of one. That lets a test before(:suite) reset before any acting nuid is set.

Examples:

AtlasRb::Reset.clean

Raises:

  • (AtlasRb::ResourceError)

    on any other non-2xx — notably where the env gate is closed. A reset that did not happen has to be loud: a suite that carries on against un-wiped state fails somewhere else entirely.



160
161
162
# File 'lib/atlas_rb.rb', line 160

def self.clean(nuid: nil, on_behalf_of: nil)
  connection({}, nuid, on_behalf_of: on_behalf_of, auth: :optional).get("/reset")&.body
end