github.com/rstandt/terraform@v0.12.32-0.20230710220336-b1063613405c/state/remote/remote_test.go (about)

     1  package remote
     2  
     3  import (
     4  	"bytes"
     5  	"crypto/md5"
     6  	"encoding/json"
     7  	"testing"
     8  
     9  	"github.com/hashicorp/terraform/state"
    10  	"github.com/hashicorp/terraform/states/statefile"
    11  )
    12  
    13  // testClient is a generic function to test any client.
    14  func testClient(t *testing.T, c Client) {
    15  	var buf bytes.Buffer
    16  	s := state.TestStateInitial()
    17  	sf := &statefile.File{State: s}
    18  	if err := statefile.Write(sf, &buf); err != nil {
    19  		t.Fatalf("err: %s", err)
    20  	}
    21  	data := buf.Bytes()
    22  
    23  	if err := c.Put(data); err != nil {
    24  		t.Fatalf("put: %s", err)
    25  	}
    26  
    27  	p, err := c.Get()
    28  	if err != nil {
    29  		t.Fatalf("get: %s", err)
    30  	}
    31  	if !bytes.Equal(p.Data, data) {
    32  		t.Fatalf("bad: %#v", p)
    33  	}
    34  
    35  	if err := c.Delete(); err != nil {
    36  		t.Fatalf("delete: %s", err)
    37  	}
    38  
    39  	p, err = c.Get()
    40  	if err != nil {
    41  		t.Fatalf("get: %s", err)
    42  	}
    43  	if p != nil {
    44  		t.Fatalf("bad: %#v", p)
    45  	}
    46  }
    47  
    48  func TestRemoteClient_noPayload(t *testing.T) {
    49  	s := &State{
    50  		Client: nilClient{},
    51  	}
    52  	if err := s.RefreshState(); err != nil {
    53  		t.Fatal("error refreshing empty remote state")
    54  	}
    55  }
    56  
    57  // nilClient returns nil for everything
    58  type nilClient struct{}
    59  
    60  func (nilClient) Get() (*Payload, error) { return nil, nil }
    61  
    62  func (c nilClient) Put([]byte) error { return nil }
    63  
    64  func (c nilClient) Delete() error { return nil }
    65  
    66  // mockClient is a client that tracks persisted state snapshots only in
    67  // memory and also logs what it has been asked to do for use in test
    68  // assertions.
    69  type mockClient struct {
    70  	current []byte
    71  	log     []mockClientRequest
    72  	force   bool
    73  }
    74  
    75  type mockClientRequest struct {
    76  	Method  string
    77  	Content map[string]interface{}
    78  }
    79  
    80  func (c *mockClient) Get() (*Payload, error) {
    81  	c.appendLog("Get", c.current)
    82  	if c.current == nil {
    83  		return nil, nil
    84  	}
    85  	checksum := md5.Sum(c.current)
    86  	return &Payload{
    87  		Data: c.current,
    88  		MD5:  checksum[:],
    89  	}, nil
    90  }
    91  
    92  func (c *mockClient) Put(data []byte) error {
    93  	if c.force {
    94  		c.appendLog("Force Put", data)
    95  	} else {
    96  		c.appendLog("Put", data)
    97  	}
    98  	c.current = data
    99  	return nil
   100  }
   101  
   102  func (c *mockClient) Delete() error {
   103  	c.appendLog("Delete", c.current)
   104  	c.current = nil
   105  	return nil
   106  }
   107  
   108  // Implements remote.ClientForcePusher
   109  func (c *mockClient) EnableForcePush() {
   110  	c.force = true
   111  }
   112  
   113  func (c *mockClient) appendLog(method string, content []byte) {
   114  	// For easier test assertions, we actually log the result of decoding
   115  	// the content JSON rather than the raw bytes. Callers are in principle
   116  	// allowed to provide any arbitrary bytes here, but we know we're only
   117  	// using this to test our own State implementation here and that always
   118  	// uses the JSON state format, so this is fine.
   119  
   120  	var contentVal map[string]interface{}
   121  	if content != nil {
   122  		err := json.Unmarshal(content, &contentVal)
   123  		if err != nil {
   124  			panic(err) // should never happen because our tests control this input
   125  		}
   126  	}
   127  	c.log = append(c.log, mockClientRequest{method, contentVal})
   128  }