api_test.go

// Copyright 2017 Square Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package keysync

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net"
	"net/http"
	"testing"
	"time"

	"github.com/square/keysync/backup"

	"github.com/sirupsen/logrus"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func randomPort() uint16 {
	addr, err := net.ResolveTCPAddr("tcp", "localhost:0")
	panicOnError(err)

	listener, err := net.ListenTCP("tcp", addr)
	panicOnError(err)

	port := listener.Addr().(*net.TCPAddr).Port
	listener.Close()

	return uint16(port)
}

func waitForServer(t *testing.T, port uint16) {
	for i := 0; i < 10; i++ {
		req, err := http.NewRequest("GET", fmt.Sprintf("http://localhost:%d/status", port), nil)
		if err != nil {
			t.Fatal("error building request?")
		}

		res, err := http.DefaultClient.Do(req)
		if err != nil || res.StatusCode != http.StatusOK {
			time.Sleep(1 * time.Second)
			continue
		}
	}
}

func TestApiSyncAllAndSyncClientSuccess(t *testing.T) {
	if testing.Short() {
		t.Skip("Skipping API test in short mode.")
	}

	port := randomPort()

	server := createDefaultServerWithDeletionRace()
	defer server.Close()

	// Load a test config
	syncer, err := createNewSyncer("fixtures/configs/test-config.yaml", server)
	require.Nil(t, err)

	NewAPIServer(syncer, nil, port, logrus.NewEntry(logrus.New()), metricsForTest())
	waitForServer(t, port)

	// Test SyncAll success
	req, err := http.NewRequest("POST", fmt.Sprintf("http://localhost:%d/sync", port), nil)
	require.Nil(t, err)

	res, err := http.DefaultClient.Do(req)
	require.Nil(t, err)

	data, _ := ioutil.ReadAll(res.Body)
	require.Nil(t, err)

	status := StatusResponse{}
	err = json.Unmarshal(data, &status)
	require.Nil(t, err)
	require.True(t, status.Ok)

	// Test SyncClientsuccess
	req, err = http.NewRequest("POST", fmt.Sprintf("http://localhost:%d/sync/client1", port), nil)
	require.Nil(t, err)

	res, err = http.DefaultClient.Do(req)
	require.Nil(t, err)
	assert.Equal(t, http.StatusOK, res.StatusCode)

	data, _ = ioutil.ReadAll(res.Body)
	require.Nil(t, err)

	status = StatusResponse{}
	err = json.Unmarshal(data, &status)
	require.Nil(t, err)
	require.True(t, status.Ok)

	// Test SyncClient failure on nonexistent client
	req, err = http.NewRequest("POST", fmt.Sprintf("http://localhost:%d/sync/non-existent", port), nil)
	require.Nil(t, err)

	res, err = http.DefaultClient.Do(req)
	require.Nil(t, err)
	assert.Equal(t, http.StatusNotFound, res.StatusCode)

	data, _ = ioutil.ReadAll(res.Body)
	require.Nil(t, err)

	status = StatusResponse{}
	err = json.Unmarshal(data, &status)
	require.Nil(t, err)
	require.False(t, status.Ok)
}

func TestApiSyncOneError(t *testing.T) {
	if testing.Short() {
		t.Skip("Skipping API test in short mode.")
	}

	port := randomPort()

	config, err := LoadConfig("fixtures/configs/errorconfigs/nonexistent-client-dir-config.yaml")
	require.Nil(t, err)

	syncer, err := NewSyncer(config, OutputDirCollection{}, logrus.NewEntry(logrus.New()), metricsForTest())
	require.Nil(t, err)

	_, err = syncer.LoadClients()
	assert.NotNil(t, err)

	NewAPIServer(syncer, nil, port, logrus.NewEntry(logrus.New()), metricsForTest())
	waitForServer(t, port)

	// Test error loading clients when syncing single client
	req, err := http.NewRequest("POST", fmt.Sprintf("http://localhost:%d/sync/client1", port), nil)
	require.Nil(t, err)

	res, err := http.DefaultClient.Do(req)
	require.Nil(t, err)
	assert.Equal(t, http.StatusInternalServerError, res.StatusCode)

	// Test error loading clients when syncing all clients
	req, err = http.NewRequest("POST", fmt.Sprintf("http://localhost:%d/sync", port), nil)
	require.Nil(t, err)

	res, err = http.DefaultClient.Do(req)
	require.Nil(t, err)
	assert.Equal(t, http.StatusInternalServerError, res.StatusCode)
}

// Ensure the /backup path returns an error if no backup is configured
func TestNoBackup(t *testing.T) {
	if testing.Short() {
		t.Skip("Skipping API test in short mode.")
	}

	port := randomPort()

	server := createDefaultServerWithDeletionRace()
	defer server.Close()

	// Load a test config
	syncer, err := createNewSyncer("fixtures/configs/test-config.yaml", server)
	require.Nil(t, err)

	NewAPIServer(syncer, nil, port, logrus.NewEntry(logrus.New()), metricsForTest())
	waitForServer(t, port)

	// Call the /backup API, which should return an error
	req, err := http.NewRequest("POST", fmt.Sprintf("http://localhost:%d/backup", port), nil)
	require.Nil(t, err)

	res, err := http.DefaultClient.Do(req)
	require.Nil(t, err)

	require.EqualValues(t, http.StatusServiceUnavailable, res.StatusCode)
}

// stubBackup is used to verify the API server calls the backup object
type stubBackup struct {
	backupCalls int
}

var _ backup.Backup = &stubBackup{}

func (b *stubBackup) Backup() error {
	b.backupCalls++
	return nil
}

func (b *stubBackup) Restore([]byte) error {
	return nil
}

func TestBackup(t *testing.T) {
	if testing.Short() {
		t.Skip("Skipping API test in short mode.")
	}

	port := randomPort()

	server := createDefaultServerWithDeletionRace()
	defer server.Close()

	// Load a test config
	syncer, err := createNewSyncer("fixtures/configs/test-config.yaml", server)
	require.Nil(t, err)

	stub := stubBackup{}

	NewAPIServer(syncer, &stub, port, logrus.NewEntry(logrus.New()), metricsForTest())
	waitForServer(t, port)

	// Call the /backup API, which should call the Backup() method
	req, err := http.NewRequest("POST", fmt.Sprintf("http://localhost:%d/backup", port), nil)
	require.Nil(t, err)

	res, err := http.DefaultClient.Do(req)
	require.Nil(t, err)

	require.EqualValues(t, http.StatusOK, res.StatusCode)

	// The backup object should have been called exactly once
	require.EqualValues(t, 1, stub.backupCalls)
}

func TestHealthCheck(t *testing.T) {
	if testing.Short() {
		t.Skip("Skipping API test in short mode.")
	}

	port := randomPort()

	config, err := LoadConfig("fixtures/configs/errorconfigs/nonexistent-client-dir-config.yaml")
	require.Nil(t, err)

	syncer, err := NewSyncer(config, OutputDirCollection{}, logrus.NewEntry(logrus.New()), metricsForTest())
	require.Nil(t, err)

	_, err = syncer.LoadClients()
	assert.NotNil(t, err)

	NewAPIServer(syncer, nil, port, logrus.NewEntry(logrus.New()), metricsForTest())
	waitForServer(t, port)

	// 1. Check that health check returns false if we've never had a success
	req, err := http.NewRequest("GET", fmt.Sprintf("http://localhost:%d/status", port), nil)
	require.Nil(t, err)

	res, err := http.DefaultClient.Do(req)
	require.Nil(t, err)
	assert.Equal(t, http.StatusServiceUnavailable, res.StatusCode)

	// 2. Check health is true under good conditions (make it look like there was a successful sync)
	syncer.updateSuccessTimestamp()

	req, err = http.NewRequest("GET", fmt.Sprintf("http://localhost:%d/status", port), nil)
	require.Nil(t, err)

	res, err = http.DefaultClient.Do(req)
	require.Nil(t, err)
	assert.Equal(t, http.StatusOK, res.StatusCode)
}

func TestMetricsReporting(t *testing.T) {
	if testing.Short() {
		t.Skip("Skipping API test in short mode.")
	}

	port := randomPort()

	config, err := LoadConfig("fixtures/configs/errorconfigs/nonexistent-client-dir-config.yaml")
	require.Nil(t, err)

	syncer, err := NewSyncer(config, OutputDirCollection{}, logrus.NewEntry(logrus.New()), metricsForTest())
	require.Nil(t, err)

	_, err = syncer.LoadClients()
	assert.NotNil(t, err)

	NewAPIServer(syncer, nil, port, logrus.NewEntry(logrus.New()), metricsForTest())
	waitForServer(t, port)

	// Check health under good conditions
	req, err := http.NewRequest("GET", fmt.Sprintf("http://localhost:%d/metrics", port), nil)
	require.Nil(t, err)

	res, err := http.DefaultClient.Do(req)
	require.Nil(t, err)
	assert.Equal(t, http.StatusOK, res.StatusCode)

	// Check that metrics is valid JSON (should be an array)
	body, _ := ioutil.ReadAll(res.Body)
	var parsed []interface{}
	err = json.Unmarshal(body, &parsed)

	if err != nil {
		t.Errorf("output from /metrics is not valid JSON, though it should be: %s", err)
	}
}