status-go/lib/library_test.go

// +build e2e_test

// Tests in `./lib` package will run only when `e2e_test` build tag is provided.
// It's required to prevent some files from being included in the binary.
// Check out `lib/utils.go` for more details.

package main

import (
	"testing"

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

// the actual test functions are in non-_test.go files (so that they can use cgo i.e. import "C")
// the only intent of these wrappers is for gotest can find what tests are exposed.
func TestExportedAPI(t *testing.T) {
	testExportedAPI(t)
}

func TestValidateNodeConfig(t *testing.T) {
	noErrorsCallback := func(t *testing.T, resp APIDetailedResponse) {
		assert.Empty(t, resp.FieldErrors)
		assert.Empty(t, resp.Message)
		require.True(t, resp.Status, "expected status equal true")
	}

	testCases := []struct {
		Name     string
		Config   string
		Callback func(*testing.T, APIDetailedResponse)
	}{
		{
			Name: "response for valid config",
			Config: `{
				"NetworkId": 1,
				"DataDir": "/tmp",
				"KeyStoreDir": "/tmp",
				"NoDiscovery": true,
				"WhisperConfig": {
					"Enabled": true,
					"EnableMailServer": true,
					"DataDir": "/tmp",
					"MailServerPassword": "status-offline-inbox"
				}
			}`,
			Callback: noErrorsCallback,
		},
		{
			Name:   "response for invalid JSON string",
			Config: `{"Network": }`,
			Callback: func(t *testing.T, resp APIDetailedResponse) {
				require.False(t, resp.Status)
				require.Contains(t, resp.Message, "validation: invalid character '}'")
			},
		},
		{
			Name: "response for config missing DataDir",
			Config: `{
				"NetworkId": 3,
				"KeyStoreDir": "/tmp",
				"NoDiscovery": true,
				"WhisperConfig": {
					"Enabled": false
				}
			}`,
			Callback: func(t *testing.T, resp APIDetailedResponse) {
				require.False(t, resp.Status)
				require.Equal(t, 1, len(resp.FieldErrors))
				require.Equal(t, resp.FieldErrors[0].Parameter, "NodeConfig.DataDir")
				require.Contains(t, resp.Message, "validation: validation failed")
			},
		},
		{
			Name: "response for config missing BackupDisabledDataDir",
			Config: `{
				"NetworkId": 3,
				"DataDir": "/tmp",
				"KeyStoreDir": "/tmp",
				"NoDiscovery": true,
				"WhisperConfig": {
					"Enabled": false
				},
				"ShhextConfig": {
					"PFSEnabled": true
				}
			}`,
			Callback: func(t *testing.T, resp APIDetailedResponse) {
				require.False(t, resp.Status)
				require.Contains(t, resp.Message, "validation: field BackupDisabledDataDir is required if PFSEnabled is true")
			},
		},
		{
			Name: "response for config missing KeyStoreDir",
			Config: `{
				"NetworkId": 3,
				"DataDir": "/tmp",
				"NoDiscovery": true,
				"WhisperConfig": {
					"Enabled": false
				}
			}`,
			Callback: func(t *testing.T, resp APIDetailedResponse) {
				require.False(t, resp.Status)
				require.Equal(t, 1, len(resp.FieldErrors))
				require.Equal(t, resp.FieldErrors[0].Parameter, "NodeConfig.KeyStoreDir")
				require.Contains(t, resp.Message, "validation: validation failed")
			},
		},
		{
			Name: "response for config missing WhisperConfig.DataDir",
			Config: `{
				"NetworkId": 3,
				"DataDir": "/tmp",
				"KeyStoreDir": "/tmp",
				"NoDiscovery": true,
				"WhisperConfig": {
					"Enabled": true,
					"EnableMailServer": true
				}
			}`,
			Callback: func(t *testing.T, resp APIDetailedResponse) {
				require.False(t, resp.Status)
				require.Empty(t, resp.FieldErrors)
				require.Contains(t, resp.Message, "WhisperConfig.DataDir must be specified when WhisperConfig.EnableMailServer is true")
			},
		},
		{
			Name: "response for config missing WhisperConfig.DataDir with WhisperConfig.EnableMailServer set to false",
			Config: `{
				"NetworkId": 3,
				"DataDir": "/tmp",
				"KeyStoreDir": "/tmp",
				"NoDiscovery": true,
				"WhisperConfig": {
					"Enabled": true,
					"EnableMailServer": false
				}
			}`,
			Callback: noErrorsCallback,
		},
		{
			Name:   "response for config with multiple errors",
			Config: `{}`,
			Callback: func(t *testing.T, resp APIDetailedResponse) {
				required := map[string]string{
					"NodeConfig.NetworkID":   "required",
					"NodeConfig.DataDir":     "required",
					"NodeConfig.KeyStoreDir": "required",
				}

				require.False(t, resp.Status)
				require.Contains(t, resp.Message, "validation: validation failed")
				require.Equal(t, 3, len(resp.FieldErrors))

				for _, err := range resp.FieldErrors {
					require.Contains(t, required, err.Parameter, err.Error())
					require.Contains(t, err.Error(), required[err.Parameter])
				}
			},
		},
	}

	for _, tc := range testCases {
		t.Run(tc.Name, func(t *testing.T) {
			testValidateNodeConfig(t, tc.Config, tc.Callback)
		})
	}
}