docdb/tools/checkdocs/checkdocs_test.go

// Copyright 2021 DocDB Inc.
//
// 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.

package main

import (
	"bytes"
	"log"
	"path/filepath"
	"strings"
	"testing"

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

	"github.com/hanzoai/docdb/tools/github"
)

func TestBlogs(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping in -short mode")
	}

	blogFiles, err := filepath.Glob(filepath.Join("..", "..", "website", "blog", "*.md"))
	require.NoError(t, err)

	err = checkBlogFiles(blogFiles)
	require.NoError(t, err)
}

func TestDocs(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping in -short mode")
	}

	docFiles, err := getMarkdownFiles(filepath.Join("..", "..", "website", "docs"))
	require.NoError(t, err)
	require.NotEmpty(t, docFiles)

	p, err := github.CacheFilePath()
	require.NoError(t, err)

	client, err := github.NewClient(p, log.Printf, gh.NoopPrintf, gh.NoopPrintf)
	require.NoError(t, err)

	err = checkDocFiles(client, docFiles)
	require.NoError(t, err)
}

var fm = bytes.TrimSpace([]byte(`
slug: using-docdb-with-studio-3t
date: 2023-04-18
title: Using DocDB 1.0 with Studio 3T
authors: [alex]
description: >
	Discover how to use DocDB 1.0 with Studio 3T, and explore ways to leverage DocDB for MongoDB GUI applications.
image: /img/blog/docdb-studio3t.png
tags:
	[
		tutorial,
		mongodb compatible,
		mongodb gui,
		compatible applications,
		documents databases
	]
	`))

func TestVerifySlug(t *testing.T) {
	err := verifySlug("2023-04-18-using-docdb-with-studio.md", fm)
	assert.EqualError(t, err, `slug "using-docdb-with-studio-3t" doesn't match the file name`)
}

func TestVerifyDateNotPresent(t *testing.T) {
	err := verifyDateNotPresent(fm)
	assert.EqualError(t, err, `date field should not be present in the front matter`)
}

func TestVerifyTags(t *testing.T) {
	err := verifyTags(fm)
	assert.EqualError(t, err, `tag "documents databases" is not in the allowed list`)
}

func TestVerifyTruncateString(t *testing.T) {
	err := verifyTruncateString(fm)
	assert.EqualError(t, err, "<!--truncate--> must be included to have \"Read more\" link on the homepage")
}

func TestCheckSupportedCommands(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping in -short mode")
	}

	var buf bytes.Buffer
	l := log.New(&buf, "", 0)

	p, err := github.CacheFilePath()
	require.NoError(t, err)

	client, err := github.NewClient(p, log.Printf, gh.NoopPrintf, gh.NoopPrintf)
	require.NoError(t, err)

	for name, tc := range map[string]struct {
		Payload        string
		ExpectedOutput string
	}{
		"OpenIssueLink": {
			Payload:        "<!-- TODO https://github.com/hanzoai/docdb/issues/178 -->",
			ExpectedOutput: "",
		},

		"ClosedIssueLink": {
			Payload:        "<!-- TODO https://github.com/hanzoai/docdb/issues/1 -->",
			ExpectedOutput: "linked issue https://github.com/hanzoai/docdb/issues/1 is closed in example.md\n",
		},

		"AnyLabelClosedIssue": {
			Payload:        "[IssueLabel](https://github.com/hanzoai/docdb/issues/1)",
			ExpectedOutput: "linked issue https://github.com/hanzoai/docdb/issues/1 is closed in example.md\n",
		},
		"ClosedIssue": {
			Payload:        "https://github.com/hanzoai/docdb/issues/1",
			ExpectedOutput: "linked issue https://github.com/hanzoai/docdb/issues/1 is closed in example.md\n",
		},
		"IncorrectIssueNumber": {
			Payload:        "https://github.com/hanzoai/docdb/issues/0",
			ExpectedOutput: "incorrect issue number: https://github.com/hanzoai/docdb/issues/0 in example.md\n",
		},
		"DocumentDBIssue": {
			Payload:        "An example issue is https://github.com/documentdb/documentdb/issues/1.",
			ExpectedOutput: "linked issue https://github.com/documentdb/documentdb/issues/1 is closed in example.md\n",
		},
	} {
		t.Run(name, func(t *testing.T) {
			buf.Reset()
			r := strings.NewReader(tc.Payload)

			var failed bool

			failed, err = checkIssueURLs(client, r, "example.md", l)
			require.NoError(t, err)
			assert.Equal(t, tc.ExpectedOutput != "", failed)

			actualOutput := buf.String()
			assert.Equal(t, tc.ExpectedOutput, actualOutput)
		})
	}
}