controlpanel.go

package govcr

import (
	"net/http"

	"github.com/seborama/govcr/v15/cassette/track"
	"github.com/seborama/govcr/v15/stats"
)

// ControlPanel holds the parts of a VCR that can be interacted with.
type ControlPanel struct {
	// client is the HTTP client associated with the VCR.
	client *http.Client
}

// Stats returns Stats about the cassette and VCR session.
func (controlPanel *ControlPanel) Stats() *stats.Stats {
	return controlPanel.vcrTransport().stats()
}

// SetRequestMatchers sets a new set of RequestMatcher's to the VCR.
func (controlPanel *ControlPanel) SetRequestMatchers(requestMatcher ...RequestMatcher) {
	controlPanel.vcrTransport().SetRequestMatchers(requestMatcher...)
}

// AddRequestMatchers sets a new set of RequestMatcher's to the VCR.
func (controlPanel *ControlPanel) AddRequestMatchers(requestMatcher ...RequestMatcher) {
	controlPanel.vcrTransport().AddRequestMatchers(requestMatcher...)
}

// SetReadOnlyMode sets the VCR to read-only mode (true) or to normal read-write (false).
func (controlPanel *ControlPanel) SetReadOnlyMode(state bool) {
	controlPanel.vcrTransport().SetReadOnlyMode(state)
}

// SetNormalMode sets the VCR to normal HTTP mode.
func (controlPanel *ControlPanel) SetNormalMode() {
	controlPanel.vcrTransport().SetNormalMode()
}

// SetOfflineMode sets the VCR to offline mode.
func (controlPanel *ControlPanel) SetOfflineMode() {
	controlPanel.vcrTransport().SetOfflineMode()
}

// SetLiveOnlyMode sets the VCR to live-only mode.
func (controlPanel *ControlPanel) SetLiveOnlyMode() {
	controlPanel.vcrTransport().SetLiveOnlyMode()
}

// SetCipher sets the cassette Cipher.
// This can be used to set a cipher when none is present (which already happens automatically
// when loading a cassette) or change the cipher when one is already present.
// The cassette is automatically saved with the new selected cipher.
func (controlPanel *ControlPanel) SetCipher(crypter CrypterProvider, keyFile string) error {
	return controlPanel.vcrTransport().SetCipher(crypter, keyFile)
}

// AddRecordingMutators adds a set of recording Track Mutator's to the VCR.
func (controlPanel *ControlPanel) AddRecordingMutators(trackMutators ...track.Mutator) {
	controlPanel.vcrTransport().AddRecordingMutators(trackMutators...)
}

// SetRecordingMutators replaces the set of recording Track Mutator's in the VCR.
func (controlPanel *ControlPanel) SetRecordingMutators(trackMutators ...track.Mutator) {
	controlPanel.vcrTransport().SetRecordingMutators(trackMutators...)
}

// ClearRecordingMutators clears the set of recording Track Mutator's from the VCR.
func (controlPanel *ControlPanel) ClearRecordingMutators() {
	controlPanel.vcrTransport().ClearRecordingMutators()
}

// AddReplayingMutators adds a set of replaying Track Mutator's to the VCR.
// Replaying happens AFTER the request has been matched. As such, while the track's Request
// could be mutated, it will have no effect.
// However, the Request data can be referenced as part of mutating the Response.
func (controlPanel *ControlPanel) AddReplayingMutators(trackMutators ...track.Mutator) {
	controlPanel.vcrTransport().AddReplayingMutators(trackMutators...)
}

// SetReplayingMutators replaces the set of replaying Track Mutator's in the VCR.
func (controlPanel *ControlPanel) SetReplayingMutators(trackMutators ...track.Mutator) {
	controlPanel.vcrTransport().SetReplayingMutators(trackMutators...)
}

// ClearReplayingMutators clears the set of replaying Track Mutator's from the VCR.
func (controlPanel *ControlPanel) ClearReplayingMutators() {
	controlPanel.vcrTransport().ClearReplayingMutators()
}

// HTTPClient returns the http.Client that contains the VCR.
func (controlPanel *ControlPanel) HTTPClient() *http.Client {
	return controlPanel.client
}

// NumberOfTracks returns the number of tracks contained in the cassette.
func (controlPanel *ControlPanel) NumberOfTracks() int32 {
	return controlPanel.vcrTransport().NumberOfTracks()
}

func (controlPanel *ControlPanel) vcrTransport() *vcrTransport {
	return controlPanel.client.Transport.(*vcrTransport) //nolint:errcheck // either way, this would require a panic.
}