Starts a refactor (#898)

web/routes_test.go

@@ -0,0 +1,352 @@
+package web
+
+import (
+	"context"
+	"errors"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"testing"
+
+	"github.com/magiconair/properties/assert"
+
+	"github.com/amir20/dozzle/docker"
+	"github.com/beme/abide"
+	"github.com/gobuffalo/packr"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/require"
+)
+
+type MockedClient struct {
+	mock.Mock
+	docker.Client
+}
+
+func (m *MockedClient) FindContainer(id string) (docker.Container, error) {
+	args := m.Called(id)
+	container, ok := args.Get(0).(docker.Container)
+	if !ok {
+		panic("containers is not of type docker.Container")
+	}
+	return container, args.Error(1)
+}
+
+func (m *MockedClient) ListContainers() ([]docker.Container, error) {
+	args := m.Called()
+	containers, ok := args.Get(0).([]docker.Container)
+	if !ok {
+		panic("containers is not of type []docker.Container")
+	}
+	return containers, args.Error(1)
+}
+
+func (m *MockedClient) ContainerLogs(ctx context.Context, id string, tailSize int, since string) (<-chan string, <-chan error) {
+	args := m.Called(ctx, id, tailSize)
+	channel, ok := args.Get(0).(chan string)
+	if !ok {
+		panic("channel is not of type chan string")
+	}
+
+	err, ok := args.Get(1).(chan error)
+	if !ok {
+		panic("error is not of type chan error")
+	}
+	return channel, err
+}
+
+func (m *MockedClient) Events(ctx context.Context) (<-chan docker.ContainerEvent, <-chan error) {
+	args := m.Called(ctx)
+	channel, ok := args.Get(0).(chan docker.ContainerEvent)
+	if !ok {
+		panic("channel is not of type chan events.Message")
+	}
+
+	err, ok := args.Get(1).(chan error)
+	if !ok {
+		panic("error is not of type chan error")
+	}
+	return channel, err
+}
+
+func (m *MockedClient) ContainerStats(context.Context, string, chan<- docker.ContainerStat) error {
+	return nil
+}
+
+func Test_handler_streamLogs_happy(t *testing.T) {
+	id := "123456"
+	req, err := http.NewRequest("GET", "/api/logs/stream", nil)
+	q := req.URL.Query()
+	q.Add("id", id)
+	req.URL.RawQuery = q.Encode()
+	require.NoError(t, err, "NewRequest should not return an error.")
+
+	mockedClient := new(MockedClient)
+
+	messages := make(chan string)
+	errChannel := make(chan error)
+	mockedClient.On("FindContainer", id).Return(docker.Container{ID: id}, nil)
+	mockedClient.On("ContainerLogs", mock.Anything, mock.Anything, 300).Return(messages, errChannel)
+	go func() {
+		messages <- "INFO Testing logs..."
+		close(messages)
+	}()
+
+	h := handler{client: mockedClient, config: &Config{TailSize: 300}}
+	handler := http.HandlerFunc(h.streamLogs)
+	rr := httptest.NewRecorder()
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+	mockedClient.AssertExpectations(t)
+}
+
+func Test_handler_streamLogs_happy_with_id(t *testing.T) {
+	id := "123456"
+	req, err := http.NewRequest("GET", "/api/logs/stream", nil)
+	q := req.URL.Query()
+	q.Add("id", id)
+	req.URL.RawQuery = q.Encode()
+	require.NoError(t, err, "NewRequest should not return an error.")
+
+	mockedClient := new(MockedClient)
+
+	messages := make(chan string)
+	errChannel := make(chan error)
+	mockedClient.On("FindContainer", id).Return(docker.Container{ID: id}, nil)
+	mockedClient.On("ContainerLogs", mock.Anything, mock.Anything, 300).Return(messages, errChannel)
+	go func() {
+		messages <- "2020-05-13T18:55:37.772853839Z INFO Testing logs..."
+		close(messages)
+	}()
+
+	h := handler{client: mockedClient, config: &Config{TailSize: 300}}
+	handler := http.HandlerFunc(h.streamLogs)
+	rr := httptest.NewRecorder()
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+	mockedClient.AssertExpectations(t)
+}
+
+func Test_handler_streamLogs_happy_container_stopped(t *testing.T) {
+	id := "123456"
+	req, err := http.NewRequest("GET", "/api/logs/stream", nil)
+	q := req.URL.Query()
+	q.Add("id", id)
+	req.URL.RawQuery = q.Encode()
+	require.NoError(t, err, "NewRequest should not return an error.")
+
+	mockedClient := new(MockedClient)
+	messages := make(chan string)
+	errChannel := make(chan error)
+	mockedClient.On("FindContainer", id).Return(docker.Container{ID: id}, nil)
+	mockedClient.On("ContainerLogs", mock.Anything, id, 300).Return(messages, errChannel)
+
+	go func() {
+		errChannel <- io.EOF
+		close(messages)
+	}()
+
+	h := handler{client: mockedClient, config: &Config{TailSize: 300}}
+	handler := http.HandlerFunc(h.streamLogs)
+	rr := httptest.NewRecorder()
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+	mockedClient.AssertExpectations(t)
+}
+
+func Test_handler_streamLogs_error_finding_container(t *testing.T) {
+	id := "123456"
+	req, err := http.NewRequest("GET", "/api/logs/stream", nil)
+	q := req.URL.Query()
+	q.Add("id", id)
+	req.URL.RawQuery = q.Encode()
+	require.NoError(t, err, "NewRequest should not return an error.")
+
+	mockedClient := new(MockedClient)
+	mockedClient.On("FindContainer", id).Return(docker.Container{}, errors.New("error finding container"))
+
+	h := handler{client: mockedClient, config: &Config{TailSize: 300}}
+	handler := http.HandlerFunc(h.streamLogs)
+	rr := httptest.NewRecorder()
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+	mockedClient.AssertExpectations(t)
+}
+
+func Test_handler_streamLogs_error_reading(t *testing.T) {
+	id := "123456"
+	req, err := http.NewRequest("GET", "/api/logs/stream", nil)
+	q := req.URL.Query()
+	q.Add("id", id)
+	req.URL.RawQuery = q.Encode()
+	require.NoError(t, err, "NewRequest should not return an error.")
+
+	mockedClient := new(MockedClient)
+	messages := make(chan string)
+	errChannel := make(chan error)
+	mockedClient.On("FindContainer", id).Return(docker.Container{ID: id}, nil)
+	mockedClient.On("ContainerLogs", mock.Anything, id, 300).Return(messages, errChannel)
+
+	go func() {
+		errChannel <- errors.New("test error")
+		close(messages)
+	}()
+
+	h := handler{client: mockedClient, config: &Config{TailSize: 300}}
+	handler := http.HandlerFunc(h.streamLogs)
+	rr := httptest.NewRecorder()
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+	mockedClient.AssertExpectations(t)
+}
+
+func Test_handler_streamEvents_happy(t *testing.T) {
+	req, err := http.NewRequest("GET", "/api/events/stream", nil)
+	require.NoError(t, err, "NewRequest should not return an error.")
+	mockedClient := new(MockedClient)
+	messages := make(chan docker.ContainerEvent)
+	errChannel := make(chan error)
+	mockedClient.On("Events", mock.Anything).Return(messages, errChannel)
+	mockedClient.On("ListContainers").Return([]docker.Container{}, nil)
+
+	go func() {
+		messages <- docker.ContainerEvent{
+			Name:    "start",
+			ActorID: "1234",
+		}
+		messages <- docker.ContainerEvent{
+			Name:    "something-random",
+			ActorID: "1234",
+		}
+		close(messages)
+	}()
+
+	h := handler{client: mockedClient, config: &Config{TailSize: 300}}
+	handler := http.HandlerFunc(h.streamEvents)
+	rr := httptest.NewRecorder()
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+	mockedClient.AssertExpectations(t)
+}
+
+func Test_handler_streamEvents_error(t *testing.T) {
+	req, err := http.NewRequest("GET", "/api/events/stream", nil)
+	require.NoError(t, err, "NewRequest should not return an error.")
+	mockedClient := new(MockedClient)
+	messages := make(chan docker.ContainerEvent)
+	errChannel := make(chan error)
+	mockedClient.On("Events", mock.Anything).Return(messages, errChannel)
+	mockedClient.On("ListContainers").Return([]docker.Container{}, nil)
+
+	go func() {
+		errChannel <- errors.New("fake error")
+		close(messages)
+	}()
+
+	h := handler{client: mockedClient, config: &Config{TailSize: 300}}
+	handler := http.HandlerFunc(h.streamEvents)
+	rr := httptest.NewRecorder()
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+	mockedClient.AssertExpectations(t)
+}
+
+func Test_handler_streamEvents_error_request(t *testing.T) {
+	req, err := http.NewRequest("GET", "/api/events/stream", nil)
+	require.NoError(t, err, "NewRequest should not return an error.")
+
+	mockedClient := new(MockedClient)
+
+	messages := make(chan docker.ContainerEvent)
+	errChannel := make(chan error)
+	mockedClient.On("Events", mock.Anything).Return(messages, errChannel)
+	mockedClient.On("ListContainers").Return([]docker.Container{}, nil)
+
+	ctx, cancel := context.WithCancel(context.Background())
+	req = req.WithContext(ctx)
+
+	go func() {
+		cancel()
+	}()
+
+	h := handler{client: mockedClient, config: &Config{TailSize: 300}}
+	handler := http.HandlerFunc(h.streamEvents)
+	rr := httptest.NewRecorder()
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+	mockedClient.AssertExpectations(t)
+}
+
+func Test_createRoutes_index(t *testing.T) {
+	mockedClient := new(MockedClient)
+	box := packr.NewBox("./virtual")
+	require.NoError(t, box.AddString("index.html", "index page"), "AddString should have no error.")
+
+	handler := createRouter(&handler{mockedClient, box, &Config{Base: "/"}})
+	req, err := http.NewRequest("GET", "/", nil)
+	require.NoError(t, err, "NewRequest should not return an error.")
+	rr := httptest.NewRecorder()
+
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+}
+
+func Test_createRoutes_redirect(t *testing.T) {
+	mockedClient := new(MockedClient)
+	box := packr.NewBox("./virtual")
+
+	handler := createRouter(&handler{mockedClient, box, &Config{Base: "/foobar"}})
+	req, err := http.NewRequest("GET", "/foobar", nil)
+	require.NoError(t, err, "NewRequest should not return an error.")
+	rr := httptest.NewRecorder()
+
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+}
+
+func Test_createRoutes_foobar(t *testing.T) {
+	mockedClient := new(MockedClient)
+	box := packr.NewBox("./virtual")
+	require.NoError(t, box.AddString("index.html", "foo page"), "AddString should have no error.")
+
+	handler := createRouter(&handler{mockedClient, box, &Config{Base: "/foobar"}})
+	req, err := http.NewRequest("GET", "/foobar/", nil)
+	require.NoError(t, err, "NewRequest should not return an error.")
+	rr := httptest.NewRecorder()
+
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+}
+
+func Test_createRoutes_foobar_file(t *testing.T) {
+	mockedClient := new(MockedClient)
+	box := packr.NewBox("./virtual")
+	require.NoError(t, box.AddString("/test", "test page"), "AddString should have no error.")
+
+	handler := createRouter(&handler{mockedClient, box, &Config{Base: "/foobar"}})
+	req, err := http.NewRequest("GET", "/foobar/test", nil)
+	require.NoError(t, err, "NewRequest should not return an error.")
+	rr := httptest.NewRecorder()
+
+	handler.ServeHTTP(rr, req)
+	assert.Equal(t, rr.Body.String(), "test page", "page doesn't match")
+}
+
+func Test_createRoutes_version(t *testing.T) {
+	mockedClient := new(MockedClient)
+	box := packr.NewBox("./virtual")
+
+	handler := createRouter(&handler{mockedClient, box, &Config{Base: "/", Version: "dev"}})
+	req, err := http.NewRequest("GET", "/version", nil)
+	require.NoError(t, err, "NewRequest should not return an error.")
+	rr := httptest.NewRecorder()
+
+	handler.ServeHTTP(rr, req)
+	abide.AssertHTTPResponse(t, t.Name(), rr.Result())
+}
+
+func TestMain(m *testing.M) {
+	exit := m.Run()
+	abide.Cleanup()
+	os.Exit(exit)
+}