docker-credential-helpers/credentials/credentials_test.go

package credentials

import (
	"bytes"
	"encoding/json"
	"fmt"
	"strings"
	"testing"
)

type memoryStore struct {
	creds map[string]*Credentials
}

func newMemoryStore() *memoryStore {
	return &memoryStore{
		creds: make(map[string]*Credentials),
	}
}

func (m *memoryStore) Add(creds *Credentials) error {
	m.creds[creds.ServerURL] = creds
	return nil
}

func (m *memoryStore) Delete(serverURL string) error {
	delete(m.creds, serverURL)
	return nil
}

func (m *memoryStore) Get(serverURL string) (string, string, error) {
	c, ok := m.creds[serverURL]
	if !ok {
		return "", "", fmt.Errorf("creds not found for %s", serverURL)
	}
	return c.Username, c.Secret, nil
}

func (m *memoryStore) List() (map[string]string, error) {
	// Simply a placeholder to let memoryStore be a valid implementation of Helper interface
	return nil, nil
}

func TestStore(t *testing.T) {
	const serverURL = "https://registry.example.com/v1/"
	creds := &Credentials{
		ServerURL: serverURL,
		Username:  "foo",
		Secret:    "bar",
	}
	b, err := json.Marshal(creds)
	if err != nil {
		t.Fatal(err)
	}
	in := bytes.NewReader(b)

	h := newMemoryStore()
	if err := Store(h, in); err != nil {
		t.Fatal(err)
	}

	c, ok := h.creds[serverURL]
	if !ok {
		t.Fatalf("creds not found for %s\n", serverURL)
	}

	if c.Username != "foo" {
		t.Errorf("expected username foo, got %s\n", c.Username)
	}

	if c.Secret != "bar" {
		t.Errorf("expected username bar, got %s\n", c.Secret)
	}
}

func TestStoreMissingServerURL(t *testing.T) {
	creds := &Credentials{
		ServerURL: "",
		Username:  "foo",
		Secret:    "bar",
	}

	b, err := json.Marshal(creds)
	if err != nil {
		t.Fatal(err)
	}
	in := bytes.NewReader(b)

	h := newMemoryStore()

	if err := Store(h, in); !IsCredentialsMissingServerURL(err) {
		t.Error(err)
	}
}

func TestStoreMissingUsername(t *testing.T) {
	creds := &Credentials{
		ServerURL: "https://registry.example.com/v1/",
		Username:  "",
		Secret:    "bar",
	}

	b, err := json.Marshal(creds)
	if err != nil {
		t.Fatal(err)
	}
	in := bytes.NewReader(b)

	h := newMemoryStore()

	if err := Store(h, in); !IsCredentialsMissingUsername(err) {
		t.Error(err)
	}
}

func TestGet(t *testing.T) {
	const serverURL = "https://registry.example.com/v1/"
	creds := &Credentials{
		ServerURL: serverURL,
		Username:  "foo",
		Secret:    "bar",
	}
	b, err := json.Marshal(creds)
	if err != nil {
		t.Fatal(err)
	}
	in := bytes.NewReader(b)

	h := newMemoryStore()
	if err := Store(h, in); err != nil {
		t.Fatal(err)
	}

	buf := strings.NewReader(serverURL)
	w := new(bytes.Buffer)
	if err := Get(h, buf, w); err != nil {
		t.Fatal(err)
	}

	if w.Len() == 0 {
		t.Fatalf("expected output in the writer, got %d", w.Len())
	}

	var c Credentials
	if err := json.NewDecoder(w).Decode(&c); err != nil {
		t.Fatal(err)
	}

	if c.Username != "foo" {
		t.Errorf("expected username foo, got %s\n", c.Username)
	}

	if c.Secret != "bar" {
		t.Errorf("expected username bar, got %s\n", c.Secret)
	}
}

func TestGetMissingServerURL(t *testing.T) {
	const serverURL = "https://registry.example.com/v1/"
	creds := &Credentials{
		ServerURL: serverURL,
		Username:  "foo",
		Secret:    "bar",
	}
	b, err := json.Marshal(creds)
	if err != nil {
		t.Fatal(err)
	}
	in := bytes.NewReader(b)

	h := newMemoryStore()
	if err := Store(h, in); err != nil {
		t.Fatal(err)
	}

	buf := strings.NewReader("")
	w := new(bytes.Buffer)

	if err := Get(h, buf, w); !IsCredentialsMissingServerURL(err) {
		t.Error(err)
	}
}

func TestErase(t *testing.T) {
	const serverURL = "https://registry.example.com/v1/"
	creds := &Credentials{
		ServerURL: serverURL,
		Username:  "foo",
		Secret:    "bar",
	}
	b, err := json.Marshal(creds)
	if err != nil {
		t.Fatal(err)
	}
	in := bytes.NewReader(b)

	h := newMemoryStore()
	if err := Store(h, in); err != nil {
		t.Fatal(err)
	}

	buf := strings.NewReader(serverURL)
	if err := Erase(h, buf); err != nil {
		t.Fatal(err)
	}

	w := new(bytes.Buffer)
	if err := Get(h, buf, w); err == nil {
		t.Error("expected error getting missing creds, got empty")
	}
}

func TestEraseMissingServerURL(t *testing.T) {
	const serverURL = "https://registry.example.com/v1/"
	creds := &Credentials{
		ServerURL: serverURL,
		Username:  "foo",
		Secret:    "bar",
	}
	b, err := json.Marshal(creds)
	if err != nil {
		t.Fatal(err)
	}
	in := bytes.NewReader(b)

	h := newMemoryStore()
	if err := Store(h, in); err != nil {
		t.Fatal(err)
	}

	buf := strings.NewReader("")
	if err := Erase(h, buf); !IsCredentialsMissingServerURL(err) {
		t.Error(err)
	}
}

func TestList(t *testing.T) {
	// This tests that there is proper input an output into the byte stream
	// Individual stores are very OS specific and have been tested in osxkeychain and secretservice respectively
	out := new(bytes.Buffer)
	h := newMemoryStore()
	if err := List(h, out); err != nil {
		t.Fatal(err)
	}
	// testing that there is an output
	if out.Len() == 0 {
		t.Error("expected output in the writer, got 0")
	}
}