github.com/newrelic/newrelic-client-go@v1.1.0/pkg/plugins/plugins_test.go

//go:build unit
// +build unit

package plugins

import (
	"fmt"
	"net/http"
	"net/http/httptest"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	mock "github.com/newrelic/newrelic-client-go/pkg/testhelpers"
)

// nolint
func newTestClient(t *testing.T, handler http.Handler) Plugins {
	ts := httptest.NewServer(handler)
	tc := mock.NewTestConfig(t, ts)

	return New(tc)
}

// nolint
func newMockResponse(t *testing.T, mockJSONResponse string, statusCode int) Plugins {
	ts := mock.NewMockServer(t, mockJSONResponse, statusCode)
	tc := mock.NewTestConfig(t, ts)

	return New(tc)
}

// nolint
func newIntegrationTestClient(t *testing.T) Plugins {
	tc := mock.NewIntegrationTestConfig(t)

	return New(tc)
}

var (
	testPluginJSON = `{
		"id": 999,
		"name": "Redis",
		"guid": "net.jondoe.newrelic_redis_plugin",
		"publisher": "Jon Doe",
		"summary_metrics": [
			{
				"id": 123,
				"name": "Connected Clients",
				"metric": "Component/Connection/Clients[connections]",
				"value_function": "average_value",
				"thresholds": {
					"caution": null,
					"critical": null
				}
			},
			{
				"id": 124,
				"name": "Rejected Connections",
				"metric": "Component/ConnectionRate/Rejected[connections]",
				"value_function": "average_value",
				"thresholds": {
					"caution": null,
					"critical": null
				}
			}
		]
	}`

	testPluginDetailedJSON = `{
		"id": 999,
		"name": "Redis",
		"guid": "net.jondoe.newrelic_redis_plugin",
		"publisher": "Jon Doe",
		"details": {
			"description": "Example description",
			"is_public": null,
			"created_at": "2019-11-22T13:34:57-08:00",
			"updated_at": "2019-11-22T13:34:58-08:00",
			"last_published_at": null,
			"has_unpublished_changes": true,
			"branding_image_url": "https://url.com/path/to/image.jpg",
			"upgraded_at": "2019-11-22T13:34:57-08:00",
			"short_name": "Redis",
			"publisher_about_url": "https://github.com/publisher/newrelic_redis_plugin",
			"publisher_support_url": "https://github.com/publisher/newrelic_redis_plugin/wiki",
			"download_url": "https://github.com/publisher/newrelic_redis_plugin/releases",
			"first_edited_at": null,
			"last_edited_at": null,
			"first_published_at": null,
			"published_version": "1.0.1"
		},
		"summary_metrics": [
			{
				"id": 123,
				"name": "Connected Clients",
				"metric": "Component/Connection/Clients[connections]",
				"value_function": "average_value",
				"thresholds": {
					"caution": null,
					"critical": null
				}
			},
			{
				"id": 124,
				"name": "Rejected Connections",
				"metric": "Component/ConnectionRate/Rejected[connections]",
				"value_function": "average_value",
				"thresholds": {
					"caution": null,
					"critical": null
				}
			}
		]
	}`

	testPlugin = Plugin{
		ID:        999,
		Name:      "Redis",
		GUID:      "net.jondoe.newrelic_redis_plugin",
		Publisher: "Jon Doe",
		SummaryMetrics: []SummaryMetric{
			{
				ID:            123,
				Name:          "Connected Clients",
				Metric:        "Component/Connection/Clients[connections]",
				ValueFunction: "average_value",
				Thresholds:    MetricThreshold{},
			},
			{
				ID:            124,
				Name:          "Rejected Connections",
				Metric:        "Component/ConnectionRate/Rejected[connections]",
				ValueFunction: "average_value",
				Thresholds:    MetricThreshold{},
			},
		},
	}

	testPluginDetails = PluginDetails{
		Description:           "Example description",
		IsPublic:              false,
		CreatedAt:             "2019-11-22T13:34:57-08:00",
		UpdatedAt:             "2019-11-22T13:34:58-08:00",
		HasUnpublishedChanges: true,
		BrandingImageURL:      "https://url.com/path/to/image.jpg",
		UpgradedAt:            "2019-11-22T13:34:57-08:00",
		ShortName:             "Redis",
		PublisherAboutURL:     "https://github.com/publisher/newrelic_redis_plugin",
		PublisherSupportURL:   "https://github.com/publisher/newrelic_redis_plugin/wiki",
		DownloadURL:           "https://github.com/publisher/newrelic_redis_plugin/releases",
		PublishedVersion:      "1.0.1",
	}
)

func TestListPlugins(t *testing.T) {
	t.Parallel()
	responseJSON := fmt.Sprintf(`{"plugins": [%s]}`, testPluginJSON)
	plugins := newMockResponse(t, responseJSON, http.StatusOK)

	expected := []*Plugin{
		&testPlugin,
	}

	actual, err := plugins.ListPlugins(nil)

	assert.NoError(t, err)
	assert.NotNil(t, actual)
	assert.Equal(t, expected, actual)
}

func TestListPluginsWithParams(t *testing.T) {
	t.Parallel()
	guidFilter := "net.jondoe.newrelic_redis_plugin"
	idsFilter := "999"

	plugins := newTestClient(t, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		values := r.URL.Query()

		guid := values.Get("filter[guid]")
		require.Equal(t, guidFilter, guid)

		ids := values.Get("filter[ids]")
		require.Equal(t, idsFilter, ids)

		w.Header().Set("Content-Type", "application/json")
		_, err := w.Write([]byte(fmt.Sprintf(`{"plugins": [%s]}`, testPluginJSON)))

		require.NoError(t, err)
	}))

	params := ListPluginsParams{
		GUID: guidFilter,
		IDs:  []int{999},
	}

	expected := []*Plugin{
		&testPlugin,
	}

	actual, err := plugins.ListPlugins(&params)

	assert.NoError(t, err)
	assert.NotNil(t, actual)
	assert.Equal(t, expected, actual)
}

func TestListPluginsWithDetailedParam(t *testing.T) {
	t.Parallel()
	expectedDetailed := "true"

	plugins := newTestClient(t, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		guid := r.URL.Query().Get("detailed")
		require.Equal(t, expectedDetailed, guid)

		w.Header().Set("Content-Type", "application/json")
		_, err := w.Write([]byte(fmt.Sprintf(`{"plugins": [%s]}`, testPluginDetailedJSON)))

		require.NoError(t, err)
	}))

	params := ListPluginsParams{
		Detailed: true,
	}

	plugin := testPlugin
	plugin.Details = testPluginDetails

	expected := []*Plugin{
		&plugin,
	}

	actual, err := plugins.ListPlugins(&params)

	assert.NoError(t, err)
	assert.NotNil(t, actual)
	assert.Equal(t, expected, actual)
}

func TestGetPlugin(t *testing.T) {
	t.Parallel()
	responseJSON := fmt.Sprintf(`{"plugin": %s}`, testPluginJSON)
	plugins := newMockResponse(t, responseJSON, http.StatusOK)

	actual, err := plugins.GetPlugin(999, nil)

	assert.NoError(t, err)
	assert.NotNil(t, actual)
	assert.Equal(t, &testPlugin, actual)
}

func TestGetPluginWithParams(t *testing.T) {
	t.Parallel()
	expectedDetailed := "true"

	plugins := newTestClient(t, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		detailed := r.URL.Query().Get("detailed")
		require.Equal(t, expectedDetailed, detailed)

		w.Header().Set("Content-Type", "application/json")
		_, err := w.Write([]byte(fmt.Sprintf(`{"plugin": %s}`, testPluginDetailedJSON)))

		require.NoError(t, err)
	}))

	plugin := testPlugin
	plugin.Details = testPluginDetails

	params := GetPluginParams{
		Detailed: true,
	}

	actual, err := plugins.GetPlugin(999, &params)

	assert.NoError(t, err)
	assert.NotNil(t, actual)
	assert.Equal(t, &plugin, actual)
}