client_test.go

//
// Author:: Salim Afiune Maya (<afiune@lacework.net>)
// Copyright:: Copyright 2020, Lacework Inc.
// License:: Apache License, Version 2.0
//
// 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 api_test

import (
	"crypto/tls"
	"fmt"
	"net/http"
	"testing"
	"time"

	"github.com/cenkalti/backoff/v4"
	"github.com/stretchr/testify/assert"

	"github.com/lacework/go-sdk/v2/api"
	"github.com/lacework/go-sdk/v2/internal/lacework"
)

func TestNewClient(t *testing.T) {
	c, err := api.NewClient("test")
	if assert.Nil(t, err) {
		assert.Equal(t, "v2", c.ApiVersion(), "default API version should be v2")
		assert.Equal(t, "https://test.lacework.net", c.URL(), "domain does not match")
	}
}

func TestNewClientFullDomainURL(t *testing.T) {
	c, err := api.NewClient("account.lacework.net")
	if assert.Nil(t, err) {
		assert.Equal(t, "https://account.lacework.net", c.URL(), "domain should be detected and correctly configured")
	}
}

func TestNewClientUrlInternal(t *testing.T) {
	c, err := api.NewClient("account.corp.lacework.net")
	if assert.Nil(t, err) {
		assert.Equal(t, "https://account.corp.lacework.net", c.URL(), "domain should be detected and correctly configured")
	}
}

func TestNewClientUrlWithSubaccount(t *testing.T) {
	c, err := api.NewClient("subaccount.account.lacework.net")
	if assert.Nil(t, err) {
		assert.Equal(t, "https://subaccount.account.lacework.net", c.URL(), "domain should be detected and correctly configured")
	}
}

func TestNewClientUrlInternalWithSubaccount(t *testing.T) {
	c, err := api.NewClient("subaccount.account.corp.lacework.net")
	if assert.Nil(t, err) {
		assert.Equal(t, "https://subaccount.account.corp.lacework.net", c.URL(), "domain should be detected and correctly configured")
	}
}

func TestNewClientAccountEmptyError(t *testing.T) {
	c, err := api.NewClient("")
	assert.Nil(t, c)
	if assert.NotNil(t, err) {
		assert.Equal(t, "account cannot be empty", err.Error(),
			"we cannot create an api client without a Lacework account")
	}
}

func TestNewClientWithOptions(t *testing.T) {
	fakeServer := lacework.MockServer()
	fakeServer.MockToken("TOKEN")
	defer fakeServer.Close()

	c, err := api.NewClient("test",
		api.WithURL(fakeServer.URL()),
		api.WithExpirationTime(1800),
		api.WithTimeout(time.Minute*5),
		api.WithRetries(backoff.NewExponentialBackOff()),
		api.WithLogLevel("DEBUG"),
		api.WithHeader("User-Agent", "test-agent"),
		api.WithTokenFromKeys("KEY", "SECRET"), // this option has to be the last one
	)
	if assert.Nil(t, err) {
		assert.Equal(t, "v2", c.ApiVersion(), "modified API version should be v2")
	}
}

func TestCopyClientWithOptions(t *testing.T) {
	var v interface{}
	fakeServer := lacework.MockServer()
	fakeServer.MockToken("TOKEN")
	fakeServer.MockAPI(
		"endpoint-org-access",
		func(w http.ResponseWriter, r *http.Request) {
			assert.Equal(t, "true", r.Header.Get("Org-Access"))
			fmt.Fprintf(w, "{}")
		},
	)
	fakeServer.MockAPI(
		"endpoint-NO-org-access",
		func(w http.ResponseWriter, r *http.Request) {
			assert.Equal(t, "", r.Header.Get("Org-Access"))
			fmt.Fprintf(w, "{}")
		},
	)

	defer fakeServer.Close()

	c, err := api.NewClient("test",
		api.WithURL(fakeServer.URL()),
		api.WithExpirationTime(1800),
		api.WithTimeout(time.Minute*5),
		api.WithRetries(backoff.NewExponentialBackOff()),
		api.WithLogLevel("DEBUG"),
		api.WithHeader("User-Agent", "test-agent"),
		api.WithTokenFromKeys("KEY", "SECRET"), // this option has to be the last one
	)
	if assert.Nil(t, err) {
		assert.Equal(t, "v2", c.ApiVersion(), "default API version should be v2")
		assert.Contains(t, c.URL(), "http://127.0.0.1:", "wrong URL")
		assert.True(t, c.ValidAuth())
	}

	err = c.RequestDecoder("GET", "endpoint-NO-org-access", nil, v)
	assert.Nil(t, err)

	newExactClient, err := api.CopyClient(c)
	if assert.Nil(t, err) {
		assert.Equal(t, c.ApiVersion(), newExactClient.ApiVersion(), "copy client mismatch")
		assert.Equal(t, c.URL(), newExactClient.URL(), "copy client mismatch")
		assert.Equal(t, c.Retries(), newExactClient.Retries(), "copy retrying mistmatch")
		assert.True(t, newExactClient.ValidAuth())
	}

	td, err := newExactClient.GenerateToken()
	if assert.Nil(t, err) {
		assert.Equal(t, "TOKEN", td.Token)
	}

	newModifiedClient, err := api.CopyClient(c,
		api.WithURL("https://new.lacework.net/"),
		api.WithExpirationTime(3600),
		api.WithTimeout(time.Minute*60), // LOL!
		api.WithRetries(nil),
		api.WithLogLevel("INFO"),
		api.WithOrgAccess(),
	)
	if assert.Nil(t, err) {
		assert.NotEqual(t, c.URL(), newModifiedClient.URL(), "copy modified client mismatch")
		assert.NotEqual(t, c.Retries(), newModifiedClient.Retries(), "copy modified retrying policy")
		assert.Equal(t, "v2", newModifiedClient.ApiVersion(), "copy modified API version should be v2")
		assert.Equal(t, "https://new.lacework.net/", newModifiedClient.URL(), "copy modified client mismatch")
		assert.True(t, newExactClient.ValidAuth())
	}

	err = c.RequestDecoder("GET", "endpoint-org-access", nil, v)
	assert.Nil(t, err)
}

func TestNewClientWithOrgAccess(t *testing.T) {
	fakeServer := lacework.MockServer()
	fakeServer.MockToken("TOKEN")
	defer fakeServer.Close()

	c, err := api.NewClient("test",
		api.WithOrgAccess(),
	)
	assert.NoError(t, err)
	assert.Equal(t, true, c.OrgAccess(), "org access should be set to true")

}

func TestNewClientWithoutOrgAccess(t *testing.T) {
	fakeServer := lacework.MockServer()
	fakeServer.MockToken("TOKEN")
	defer fakeServer.Close()

	c, err := api.NewClient("test")
	assert.NoError(t, err)
	assert.Equal(t, false, c.OrgAccess(), "org access should be set to false")

}

func TestTLSHandshakeTimeout(t *testing.T) {
	fakeServer := lacework.MockUnstartedServer()
	fakeServer.Server.TLS = &tls.Config{InsecureSkipVerify: true}
	apiPath := "AlertChannels"
	fakeServer.MockToken("TOKEN")
	fakeServer.Server.StartTLS()
	defer fakeServer.Close()

	fakeServer.MockAPI(apiPath, func(w http.ResponseWriter, r *http.Request) {
		time.Sleep(time.Second * 1)
		fmt.Fprintf(w, "{}")
	})

	shortTimeout := &http.Transport{TLSHandshakeTimeout: time.Millisecond * 1,
		TLSClientConfig: &tls.Config{InsecureSkipVerify: true}}

	client, err := api.NewClient("test",
		api.WithToken("TOKEN"),
		api.WithURL(fakeServer.URL()),
		api.WithTransport(shortTimeout),
	)

	_, err = client.V2.AlertChannels.List()
	assert.ErrorContains(t, err, "TLS handshake timeout", "Expected TLS timeout error")

	longTimeout := &http.Transport{TLSHandshakeTimeout: time.Second * 2,
		TLSClientConfig: &tls.Config{InsecureSkipVerify: true}}

	clientWithTimeout, err := api.NewClient("test",
		api.WithToken("TOKEN"),
		api.WithURL(fakeServer.URL()),
		api.WithTransport(longTimeout),
	)

	_, err = clientWithTimeout.V2.AlertChannels.List()
	assert.NoError(t, err)
}

func TestClientWithRetries(t *testing.T) {
	fakeServer := lacework.MockUnstartedServer()
	apiPath := "AlertChannels"
	fakeServer.MockToken("TOKEN")
	fakeServer.Server.StartTLS()
	defer fakeServer.Close()

	requestNumber := 0
	fakeServer.MockAPI(apiPath, func(w http.ResponseWriter, r *http.Request) {
		requestNumber += 1
		if requestNumber == 3 {
			w.WriteHeader(200)
			fmt.Fprintf(w, "{}")
		} else {
			w.WriteHeader(500)
		}
	})

	transport := &http.Transport{TLSClientConfig: &tls.Config{InsecureSkipVerify: true}}
	client, err := api.NewClient("test",
		api.WithToken("TOKEN"),
		api.WithURL(fakeServer.URL()),
		api.WithTransport(transport),
	)

	_, err = client.V2.AlertChannels.List()
	assert.Error(t, err)

	clientWithRetries, err := api.NewClient("test",
		api.WithToken("TOKEN"),
		api.WithURL(fakeServer.URL()),
		api.WithTransport(transport),
		api.WithRetries(backoff.NewExponentialBackOff()),
	)

	_, err = clientWithRetries.V2.AlertChannels.List()
	assert.NoError(t, err)
}