Function TestGeneratePluginDocs

cli/internal/docs/generator_test.go:164–205

(t *testing.T)

}

func TestGeneratePluginDocs(t *testing.T) {
	g := NewGenerator("test", testTables)
	cup := cupaloy.New(cupaloy.SnapshotSubdirectory("testdata"))

	t.Run("Markdown", func(t *testing.T) {
		tmpdir := t.TempDir()

		err := g.Generate(tmpdir, FormatMarkdown)
		if err != nil {
			t.Fatalf("unexpected error calling GeneratePluginDocs: %v", err)
		}

		expectFiles := []string{"test_table.md", "relation_table.md", "relation_relation_table_a.md", "relation_relation_table_b.md", "incremental_table.md", "paid_table.md", "README.md", "test_table_with_primary_key_component.md"}
		for _, exp := range expectFiles {
			t.Run(exp, func(t *testing.T) {
				output := path.Join(tmpdir, exp)
				got, err := os.ReadFile(output)
				require.NoError(t, err)
				cup.SnapshotT(t, got)
			})
		}
	})

	t.Run("JSON", func(t *testing.T) {
		tmpdir := t.TempDir()

		err := g.Generate(tmpdir, FormatJSON)
		if err != nil {
			t.Fatalf("unexpected error calling GeneratePluginDocs: %v", err)
		}

		expectFiles := []string{"__tables.json"}
		for _, exp := range expectFiles {
			t.Run(exp, func(t *testing.T) {
				output := path.Join(tmpdir, exp)
				got, err := os.ReadFile(output)
				require.NoError(t, err)
				cup.SnapshotT(t, got)
			})
		}
	})
}