reference_test.go

// Copyright © 2022 Kaleido, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
// 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.

//go:build !reference
// +build !reference

package reference

import (
	"context"
	"crypto/sha1"
	"fmt"
	"os"
	"path/filepath"
	"reflect"
	"testing"

	"github.com/hyperledger/firefly-common/pkg/i18n"
	"github.com/stretchr/testify/assert"
	"golang.org/x/text/language"
)

func TestCheckGeneratedMarkdownPages(t *testing.T) {
	ctx := i18n.WithLang(context.Background(), language.Spanish)
	markdownMap, err := GenerateObjectsReferenceMarkdown(ctx)
	assert.NoError(t, err)
	assert.NotNil(t, markdownMap)

	for pageName, markdown := range markdownMap {
		b, err := os.ReadFile(filepath.Join("..", "..", "doc-site", "docs", "reference", "types", fmt.Sprintf("%s.md", pageName)))
		assert.NoError(t, err)
		expectedPageHash := sha1.New()
		expectedPageHash.Write(b)
		actualPageHash := sha1.New()
		actualPageHash.Write(markdown)
		assert.Equal(t, expectedPageHash.Sum(nil), actualPageHash.Sum(nil), "The type reference docs generated by the code did not match the docs files in git for page: '%s.md' Did you forget to run `make reference`?", pageName)
	}
}

func TestGenerateMarkdownPagesNonPointer(t *testing.T) {
	_, _, err := generateObjectReferenceMarkdown(context.Background(), false, "foo", reflect.TypeOf("foo"), []string{}, []string{}, []string{}, "outputPath")
	assert.NoError(t, err)
}

func TestGenerateMarkdownPagesBadJSON(t *testing.T) {
	type badJSON map[bool]bool
	_, err := generateMarkdownPages(context.Background(), []interface{}{badJSON{true: false}}, []interface{}{}, "../../test")
	assert.Regexp(t, "badJSON", err)
}

func TestGenerateMarkdownDescriptionMissing(t *testing.T) {
	type thingy struct{}
	_, err := generateMarkdownPages(context.Background(), []interface{}{thingy{}}, []interface{}{}, "")
	assert.Regexp(t, "FF10387.*thingy_description.md", err)
}

func TestGenerateMarkdownAnonymousStruct(t *testing.T) {
	type thing2 struct {
		Kite string `json:"kite" ffstruct:"thing2"`
	}
	type thing1 struct {
		thing2
	}
	refdocs, err := generateMarkdownPages(context.Background(), []interface{}{thing1{
		thing2{
			Kite: "green and yellow",
		},
	}}, []interface{}{}, "../../test")
	assert.NoError(t, err)
	assert.Regexp(t, "\\| `kite` \\|", string(refdocs["thing1"]))
}