graphql-engine/cli/integration_test/v3/metadata.go

package v3

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
	"os"
	"path/filepath"
	"testing"

	"github.com/hasura/graphql-engine/cli"
	"github.com/hasura/graphql-engine/cli/commands"
	"github.com/hasura/graphql-engine/cli/util"
	"github.com/stretchr/testify/assert"
)

type metadataInterface interface {
	Run() error
}

func TestMetadataCmd(t *testing.T, ec *cli.ExecutionContext) {
	currDir, _ := os.Getwd()
	tt := []struct {
		name                   string
		opts                   metadataInterface
		err                    error
		copyMetadataFolder     string
		expectedMetadataFolder string
	}{
		{
			"metadata-export",
			&commands.MetadataExportOptions{
				EC:         ec,
				ActionType: "export",
			},
			nil,
			"",
			filepath.Join(currDir, getMetadataDir(ec.Version.ServerSemver), "1_metadata"),
		},
		{
			"metadata-apply",
			&commands.MetadataApplyOptions{
				EC:         ec,
				ActionType: "apply",
			},
			nil,
			filepath.Join(currDir, getMetadataDir(ec.Version.ServerSemver), "2_metadata"),
			"",
		},
		{
			"metadata-export",
			&commands.MetadataExportOptions{
				EC:         ec,
				ActionType: "export",
			},
			nil,
			"",
			filepath.Join(currDir, getMetadataDir(ec.Version.ServerSemver), "2_metadata"),
		},
		{
			"metadata-clear",
			&commands.MetadataClearOptions{
				EC:         ec,
				ActionType: "clear",
			},
			nil,
			"",
			"",
		},
		{
			"metadata-export",
			&commands.MetadataExportOptions{
				EC:         ec,
				ActionType: "export",
			},
			nil,
			"",
			filepath.Join(currDir, getMetadataDir(ec.Version.ServerSemver), "1_metadata"),
		},
		{
			"metadata-diff",
			&commands.MetadataDiffOptions{
				EC:     ec,
				Args:   []string{filepath.Join(currDir, getMetadataDir(ec.Version.ServerSemver), "1_metadata")},
				Output: new(bytes.Buffer),
			},
			nil,
			"",
			"",
		},
		{
			"down-all-migrations",
			&commands.MigrateApplyOptions{
				EC:            ec,
				DownMigration: "all",
				Datasource:    "default",
			},
			nil,
			"",
			"",
		},
	}

	for _, tc := range tt {
		t.Run(tc.name, func(t *testing.T) {
			if tc.copyMetadataFolder != "" {
				err := os.RemoveAll(ec.MetadataDir)
				if err != nil {
					t.Fatalf("%s: unable to remove metadata directory, got %v", tc.name, err)
				}
				err = util.CopyDir(tc.copyMetadataFolder, ec.MetadataDir)
				if err != nil {
					t.Fatalf("%s: unable to copy metadata file, got %v", tc.name, err)
				}
			}
			err := tc.opts.Run()
			if err != tc.err {
				t.Fatalf("%s: expected %v, got %v", tc.name, tc.err, err)
			}
			if tc.expectedMetadataFolder != "" {
				assert.DirExists(t, ec.MetadataDir)
				files, err := ioutil.ReadDir(tc.expectedMetadataFolder)
				if err != nil {
					t.Fatalf("%s: unable to read expected metadata directory, got %v", tc.name, err)
				}

				for _, file := range files {
					name := file.Name()
					expectedByt, err := ioutil.ReadFile(filepath.Join(tc.expectedMetadataFolder, name))
					if err != nil {
						t.Fatalf("%s: unable to read expected metadata file %s, got %v", tc.name, name, err)
					}
					actualByt, err := ioutil.ReadFile(filepath.Join(ec.MetadataDir, name))
					if err != nil {
						t.Fatalf("%s: unable to read actual metadata file %s, got %v", tc.name, name, err)
					}
					assert.Equal(t, string(expectedByt), string(actualByt))
				}
			}
		})
	}
}

func TestIncompleteMetadataDir(t *testing.T, ec *cli.ExecutionContext) {
	currDir, _ := os.Getwd()
	tt := []struct {
		name               string
		opts               metadataInterface
		err                error
		copyMetadataFolder string
		goldenFile         string
	}{
		{
			"t1",
			&commands.MetadataExportOptions{
				EC:         ec,
				ActionType: "apply",
			},
			nil,
			filepath.Join(currDir, "testdata/incomplete_metadata/t1/metadata"),
			filepath.Join(currDir, "testdata/incomplete_metadata/t1/from-server.golden"),
		},
		{
			"t2",
			&commands.MetadataExportOptions{
				EC:         ec,
				ActionType: "apply",
			},
			nil,
			filepath.Join(currDir, "testdata/incomplete_metadata/t2/metadata"),
			filepath.Join(currDir, "testdata/incomplete_metadata/t2/from-server.golden"),
		},
	}

	for _, tc := range tt {
		t.Run(tc.name, func(t *testing.T) {
			if tc.copyMetadataFolder != "" {
				err := os.RemoveAll(ec.MetadataDir)
				if err != nil {
					t.Fatalf("%s: unable to remove metadata directory, got %v", tc.name, err)
				}
				err = util.CopyDir(tc.copyMetadataFolder, ec.MetadataDir)
				if err != nil {
					t.Fatalf("%s: unable to copy metadata file, got %v", tc.name, err)
				}
			}
			err := tc.opts.Run()
			if err != tc.err {
				t.Fatalf("%s: expected %v, got %v", tc.name, tc.err, err)
			}
			// get metadata from server
			testServerUrl := os.Getenv("HASURA_GRAPHQL_TEST_ENDPOINT")
			if testServerUrl == "" {
				testServerUrl = "http://localhost:8080"
			}
			url := fmt.Sprintf("%s/%s", testServerUrl, "v1/query")
			var body = []byte(`
{
    "type" : "export_metadata",
    "args": {}
}
`)
			req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(body))
			assert.NoError(t, err)
			if ec.Config.AdminSecret != "" {
				req.Header.Set(cli.XHasuraAdminSecret, ec.Config.AdminSecret)
			}
			c := http.Client{}
			resp, err := c.Do(req)

			defer resp.Body.Close()
			assert.Equal(t, resp.StatusCode, http.StatusOK)
			got, err := ioutil.ReadAll(resp.Body)
			assert.NoError(t, err)

			want, err := ioutil.ReadFile(tc.goldenFile)
			assert.NoError(t, err)
			var wantM, gotM map[string]interface{}

			err = json.Unmarshal(want, &wantM)
			assert.NoError(t, err)
			err = json.Unmarshal(got, &gotM)
			assert.NoError(t, err)

			wantB, err := json.Marshal(wantM)
			assert.NoError(t, err)
			gotB, err := json.Marshal(gotM)
			assert.NoError(t, err)

			assert.Equal(t, string(wantB), string(gotB))
		})
	}
}