legacy_analytics_test.go

// Copyright 2018 Google LLC
//
// 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 analytics

import (
	"encoding/json"
	"net/http"
	"net/http/httptest"
	"net/url"
	"strings"
	"testing"
	"time"

	"github.com/apigee/apigee-remote-service-golib/v2/auth"
	"github.com/apigee/apigee-remote-service-golib/v2/log"
)

func TestAnalyticsSubmit(t *testing.T) {
	startTime := time.Now()
	context := &TestContext{
		orgName: "org",
		envName: "env",
	}
	authContext := &auth.Context{
		Context:        context,
		DeveloperEmail: "email",
		Application:    "app",
		AccessToken:    "token",
		ClientID:       "clientId",
	}
	axRecord := Record{
		ResponseStatusCode:           201,
		RequestVerb:                  "PATCH",
		RequestPath:                  "/test",
		UserAgent:                    "007",
		ClientReceivedStartTimestamp: timeToUnix(startTime),
		ClientReceivedEndTimestamp:   timeToUnix(startTime),
		ClientSentStartTimestamp:     timeToUnix(startTime),
		ClientSentEndTimestamp:       timeToUnix(startTime),
		TargetSentStartTimestamp:     timeToUnix(startTime),
		TargetSentEndTimestamp:       timeToUnix(startTime),
		TargetReceivedStartTimestamp: timeToUnix(startTime),
		TargetReceivedEndTimestamp:   timeToUnix(startTime),
	}
	ts := makeTestServer(authContext, axRecord, t)
	defer ts.Close()
	baseURL, err := url.Parse(ts.URL)
	if err != nil {
		t.Fatal(err)
	}
	context.internalAPI = baseURL
	context.remoteServiceAPI = baseURL
	ab := &legacyAnalytics{client: http.DefaultClient}
	err = ab.SendRecords(authContext, []Record{axRecord})
	if err != nil {
		t.Fatal(err)
	}
	if context.Organization() != ts.Request.Organization {
		t.Errorf("invalid organization. want: %s, got: %s", context.Organization(), ts.Request.Organization)
	}
	if context.Environment() != ts.Request.Environment {
		t.Errorf("invalid environment. want: %s, got: %s", context.Environment(), ts.Request.Environment)
	}
	if len(ts.Request.Records) != 1 {
		t.Errorf("invalid # records. want: 1, got: %d", len(ts.Request.Records))
	}
}

func TestMissingOrg(t *testing.T) {

	context := &TestContext{
		orgName: "",
		envName: "env",
	}
	authContext := &auth.Context{
		Context:        context,
		DeveloperEmail: "email",
		Application:    "app",
		AccessToken:    "token",
		ClientID:       "clientId",
	}
	axRecord := Record{}
	ts := makeTestServer(authContext, axRecord, t)
	defer ts.Close()
	baseURL, err := url.Parse(ts.URL)
	if err != nil {
		t.Fatal(err)
	}
	context.internalAPI = baseURL
	context.remoteServiceAPI = baseURL
	ab := &legacyAnalytics{client: http.DefaultClient}
	err = ab.SendRecords(authContext, []Record{axRecord})
	if err == nil || !strings.Contains(err.Error(), "organization") {
		t.Errorf("should get missing organization error, got: %s", err)
	}
}

func TestMissingEnv(t *testing.T) {

	context := &TestContext{
		orgName: "org",
		envName: "",
	}
	authContext := &auth.Context{
		Context:        context,
		DeveloperEmail: "email",
		Application:    "app",
		AccessToken:    "token",
		ClientID:       "clientId",
	}
	axRecord := Record{}
	ts := makeTestServer(authContext, axRecord, t)
	defer ts.Close()
	baseURL, err := url.Parse(ts.URL)
	if err != nil {
		t.Fatal(err)
	}
	context.internalAPI = baseURL
	context.remoteServiceAPI = baseURL
	ab := &legacyAnalytics{client: http.DefaultClient}
	err = ab.SendRecords(authContext, []Record{axRecord})
	if err == nil || !strings.Contains(err.Error(), "environment") {
		t.Errorf("should get missing environment error, got: %s", err)
	}
}

type testServer struct {
	*httptest.Server
	Request *legacyRequest
}

func makeTestServer(auth *auth.Context, rec Record, t *testing.T) *testServer {
	var axRequest legacyRequest
	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		decoder := json.NewDecoder(r.Body)
		err := decoder.Decode(&axRequest)
		if err != nil {
			t.Fatal(err)
		}
		defer r.Body.Close()

		log.Infof("axRequest: %#v", axRequest)

		if axRequest.Organization != auth.Organization() {
			t.Errorf("bad orgName")
		}
		if axRequest.Environment != auth.Environment() {
			t.Errorf("bad envName")
		}
		if len(axRequest.Records) != 1 {
			t.Errorf("record missing")
			return
		}

		axRecord := axRequest.Records[0]
		if axRecord.AccessToken == "" {
			t.Errorf("access_token missing")
		}
		if axRecord.ClientReceivedStartTimestamp != rec.ClientReceivedStartTimestamp {
			t.Errorf("client_received_start_timestamp expected: %v, got: %v",
				rec.ClientReceivedStartTimestamp, axRecord.ClientReceivedStartTimestamp)
		}

		w.WriteHeader(200)
		resp := legacyResponse{
			Accepted: len(axRequest.Records),
			Rejected: 0,
		}
		_ = json.NewEncoder(w).Encode(resp)
	}))
	return &testServer{Server: ts, Request: &axRequest}
}

type TestContext struct {
	internalAPI      *url.URL
	remoteServiceAPI *url.URL
	orgName          string
	envName          string
}

func (h *TestContext) InternalAPI() *url.URL {
	return h.internalAPI
}
func (h *TestContext) RemoteServiceAPI() *url.URL {
	return h.remoteServiceAPI
}
func (h *TestContext) Organization() string {
	return h.orgName
}
func (h *TestContext) Environment() string {
	return h.envName
}

func timeToUnix(t time.Time) int64 {
	return t.UnixNano() / (int64(time.Millisecond) / int64(time.Nanosecond))
}