Skip to content

Isolate fixtures and resolver cache #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Vladyslav-Kuksiuk merged 8 commits into from
Jun 26, 2026
Merged

Isolate fixtures and resolver cache #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0362b1f
Provide per-operation resolvers.
Vladyslav-Kuksiuk Jun 24, 2026
5c08012
Update tests.
Vladyslav-Kuksiuk Jun 24, 2026
1bac543
Update GitHub workflow.
Vladyslav-Kuksiuk Jun 24, 2026
d3a35f7
Merge remote-tracking branch 'refs/remotes/origin/master' into isolat…
Vladyslav-Kuksiuk Jun 25, 2026
d123dbb
Provide docs.
Vladyslav-Kuksiuk Jun 25, 2026
02f6ce3
Support `nil` resolver.
Vladyslav-Kuksiuk Jun 26, 2026
341ea29
Add orchestration test.
Vladyslav-Kuksiuk Jun 26, 2026
fd3ab8c
Fix test packge.
Vladyslav-Kuksiuk Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .github/workflows/check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ jobs:
args: ./...

- name: Run Tests
# Tests must be run sequentially because they create temporary files that can cause issues.
# Therefore, the "-p 1" argument is required.
run: go test -v ./... -p 1
run: go test -v ./...

- name: Run E2E Tests
run: go test -v -tags showcase ./showcase -p 1
run: go test -v -tags showcase ./showcase
145 changes: 32 additions & 113 deletions embedding/embedding_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ package embedding_test

import (
"errors"
"fmt"
"io"
"os"
"path/filepath"
"strings"
Expand All @@ -30,15 +28,12 @@ import (
"embed-code/embed-code-go/configuration"
"embed-code/embed-code-go/embedding"
"embed-code/embed-code-go/embedding/parsing"
"embed-code/embed-code-go/files"
_type "embed-code/embed-code-go/type"

. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
)

const temporaryTestDir = "../test/docs"

// TestEmbedding runs the embedding test suite.
func TestEmbedding(t *testing.T) {
RegisterFailHandler(Fail)
Expand All @@ -49,52 +44,39 @@ var _ = Describe("Embedding", func() {
var config configuration.Configuration

BeforeEach(func() {
currentDir, err := os.Getwd()
if err != nil {
Fail("unexpected error during the test setup: " + err.Error())
}
err = os.Chdir(currentDir)
if err != nil {
Fail("unexpected error during the test setup: " + err.Error())
}
config = buildConfigWithSourceFiles()

// Copying files not to edit them directly during the test run.
copyDirRecursive("../test/resources/docs", config.DocumentationRoot)
})

AfterEach(func() {
if err := os.RemoveAll(temporaryTestDir); err != nil {
Fail(err.Error())
}
config = buildConfigWithSourceFiles(GinkgoT().TempDir())
Expect(os.CopyFS(
config.DocumentationRoot,
os.DirFS("../test/resources/docs"),
)).To(Succeed())
})

It("should be up to date", func() {
docPath := fmt.Sprintf("%s/whole-file-fragment.md", config.DocumentationRoot)
docPath := testDocPath(config, "whole-file-fragment.md")
processor := newProcessor(docPath, config)

Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())
Expect(processor.IsUpToDate()).Should(BeTrue())
})

It("should be up to date as there is nothing to update", func() {
docPath := fmt.Sprintf("%s/no-embedding-doc.md", config.DocumentationRoot)
docPath := testDocPath(config, "no-embedding-doc.md")
processor := newProcessor(docPath, config)

Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())
Expect(processor.IsUpToDate()).Should(BeTrue())
})

It("should successfully embed with multi lined tag", func() {
docPath := fmt.Sprintf("%s/multi-lined-tag.md", config.DocumentationRoot)
docPath := testDocPath(config, "multi-lined-tag.md")
processor := newProcessor(docPath, config)
Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())

Expect(processor.IsUpToDate()).Should(BeTrue())
})

It("should embed directly from source", func() {
docPath := fmt.Sprintf("%s/doc.md", config.DocumentationRoot)
docPath := testDocPath(config, "doc.md")
processor := newProcessor(docPath, config)

Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())
Expand All @@ -104,7 +86,7 @@ var _ = Describe("Embedding", func() {

It("should report files that are not up to date", func() {
config.DocIncludes = []string{"doc.md"}
docPath := fmt.Sprintf("%s/doc.md", config.DocumentationRoot)
docPath := testDocPath(config, "doc.md")

outdatedFiles, err := embedding.CheckUpToDate(config)

Expand All @@ -113,15 +95,15 @@ var _ = Describe("Embedding", func() {
})

It("should ignore embed-code samples inside markdown code fences", func() {
docPath := fmt.Sprintf("%s/embed-code-sample-in-fence.md", config.DocumentationRoot)
docPath := testDocPath(config, "embed-code-sample-in-fence.md")
processor := newProcessor(docPath, config)

Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())
Expect(processor.IsUpToDate()).Should(BeTrue())
})

It("should detect markdown fences by triple-or-more backticks only", func() {
docPath := fmt.Sprintf("%s/triple-backticks-only-fence.md", config.DocumentationRoot)
docPath := testDocPath(config, "triple-backticks-only-fence.md")
processor := newProcessor(docPath, config)

Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())
Expand Down Expand Up @@ -179,7 +161,7 @@ var _ = Describe("Embedding", func() {
})

It("should embed with multi lined tag attributes", func() {
docPath := fmt.Sprintf("%s/multi-lined-valid-tag-attributes.md", config.DocumentationRoot)
docPath := testDocPath(config, "multi-lined-valid-tag-attributes.md")
processor := newProcessor(docPath, config)
Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())

Expand All @@ -188,7 +170,7 @@ var _ = Describe("Embedding", func() {

It("should embed a method with escaped newline patterns", func() {
config.DocIncludes = []string{"escaped-newline-pattern.md"}
docPath := fmt.Sprintf("%s/escaped-newline-pattern.md", config.DocumentationRoot)
docPath := testDocPath(config, "escaped-newline-pattern.md")
processor := newProcessor(docPath, config)

Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())
Expand All @@ -203,7 +185,7 @@ var _ = Describe("Embedding", func() {

It("should embed a method with exact escaped newline patterns", func() {
config.DocIncludes = []string{"escaped-newline-exact-pattern.md"}
docPath := fmt.Sprintf("%s/escaped-newline-exact-pattern.md", config.DocumentationRoot)
docPath := testDocPath(config, "escaped-newline-exact-pattern.md")
processor := newProcessor(docPath, config)

Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())
Expand All @@ -218,7 +200,7 @@ var _ = Describe("Embedding", func() {

It("should embed matching lines with an escaped newline line pattern", func() {
config.DocIncludes = []string{"escaped-newline-line-pattern.md"}
docPath := fmt.Sprintf("%s/escaped-newline-line-pattern.md", config.DocumentationRoot)
docPath := testDocPath(config, "escaped-newline-line-pattern.md")
processor := newProcessor(docPath, config)

Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())
Expand All @@ -233,7 +215,7 @@ var _ = Describe("Embedding", func() {

It("should embed a line with an escaped newline literal pattern", func() {
config.DocIncludes = []string{"escaped-newline-literal-pattern.md"}
docPath := fmt.Sprintf("%s/escaped-newline-literal-pattern.md", config.DocumentationRoot)
docPath := testDocPath(config, "escaped-newline-literal-pattern.md")
processor := newProcessor(docPath, config)

Expect(processor.Embed()).Error().ShouldNot(HaveOccurred())
Expand All @@ -246,7 +228,7 @@ var _ = Describe("Embedding", func() {
})

It("should report a missing closing tag", func() {
docPath := fmt.Sprintf("%s/missing-closing-tag.md", config.DocumentationRoot)
docPath := testDocPath(config, "missing-closing-tag.md")
processor := newProcessor(docPath, config)

_, err := processor.Embed()
Expand All @@ -260,7 +242,7 @@ var _ = Describe("Embedding", func() {
})

It("should preserve typed parser errors after adding document context", func() {
docPath := fmt.Sprintf("%s/missing-closing-tag.md", config.DocumentationRoot)
docPath := testDocPath(config, "missing-closing-tag.md")
processor := newProcessor(docPath, config)

_, err := processor.Embed()
Expand All @@ -278,7 +260,7 @@ var _ = Describe("Embedding", func() {
})

It("should report the XML parser error", func() {
docPath := fmt.Sprintf("%s/unclosed-nested-tag.md", config.DocumentationRoot)
docPath := testDocPath(config, "unclosed-nested-tag.md")
processor := newProcessor(docPath, config)

_, err := processor.Embed()
Expand All @@ -292,7 +274,7 @@ var _ = Describe("Embedding", func() {
})

It("should report a missing code fence after the instruction", func() {
docPath := fmt.Sprintf("%s/missing-code-fence.md", config.DocumentationRoot)
docPath := testDocPath(config, "missing-code-fence.md")
processor := newProcessor(docPath, config)

_, err := processor.Embed()
Expand All @@ -305,7 +287,7 @@ var _ = Describe("Embedding", func() {
})

It("should report an unclosed code fence after the instruction", func() {
docPath := fmt.Sprintf("%s/unclosed-code-fence.md", config.DocumentationRoot)
docPath := testDocPath(config, "unclosed-code-fence.md")
processor := newProcessor(docPath, config)

_, err := processor.Embed()
Expand All @@ -320,8 +302,7 @@ var _ = Describe("Embedding", func() {
It("should successfully embed to a file in a nested dir", func() {
config.CodeRoots = _type.NamedPathList{_type.NamedPath{Path: "../test/resources/code/kotlin"}}
config.DocIncludes = []string{"nested-dir-1/nested-dir-2/nested-dir-doc.md"}
docPath := fmt.Sprintf("%s/nested-dir-1/nested-dir-2/nested-dir-doc.md",
config.DocumentationRoot)
docPath := testDocPath(config, "nested-dir-1/nested-dir-2/nested-dir-doc.md")
processor := newProcessor(docPath, config)

result, err := embedding.EmbedAll(config)
Expand All @@ -334,7 +315,7 @@ var _ = Describe("Embedding", func() {
It("should not embed to a file matched the `doc-excludes` pattern", func() {
config.DocExcludes = []string{"**/excluded-doc.*"}

docPath := fmt.Sprintf("%s/excluded-doc.md", config.DocumentationRoot)
docPath := testDocPath(config, "excluded-doc.md")
processor := newProcessor(docPath, config)

context, err := processor.Embed()
Expand All @@ -347,16 +328,20 @@ var _ = Describe("Embedding", func() {
})
})

// buildConfigWithSourceFiles returns a configuration using source-code fixtures.
func buildConfigWithSourceFiles() configuration.Configuration {
// buildConfigWithSourceFiles builds an embedding config with an isolated documentation root.
func buildConfigWithSourceFiles(documentationRoot string) configuration.Configuration {
var config = configuration.NewConfiguration()
config.DocumentationRoot = temporaryTestDir
config.DocumentationRoot = documentationRoot
config.CodeRoots = _type.NamedPathList{_type.NamedPath{Path: "../test/resources/code/java"}}

return config
}

// newProcessor creates an embedding processor for a test documentation file.
// testDocPath returns the normalized path to a copied documentation fixture.
func testDocPath(config configuration.Configuration, name string) string {
return filepath.ToSlash(filepath.Join(config.DocumentationRoot, name))
}

func newProcessor(
docPath string,
config configuration.Configuration,
Expand All @@ -367,69 +352,3 @@ func newProcessor(

return processor
}

// copyDirRecursive copies a directory tree into the test workspace.
func copyDirRecursive(sourceDirPath string, targetDirPath string) {
info, err := os.Stat(sourceDirPath)
if err != nil {
panic(err)
}

err = os.MkdirAll(targetDirPath, info.Mode())
if err != nil {
panic(err)
}

entries, err := os.ReadDir(sourceDirPath)
if err != nil {
panic(err)
}

for _, entry := range entries {
sourcePath := filepath.Join(sourceDirPath, entry.Name())
targetPath := filepath.Join(targetDirPath, entry.Name())

if entry.IsDir() {
copyDirRecursive(sourcePath, targetPath)
} else {
err = copyFile(sourcePath, targetPath)
if err != nil {
panic(err)
}
}
}
}

// copyFile copies one fixture file into the test workspace.
func copyFile(sourceFilePath string, targetFilePath string) (err error) {
sourceFile, err := os.Open(sourceFilePath)
if err != nil {
Fail(err.Error())
}

defer func(sourceFile *os.File) {
err = sourceFile.Close()
if err != nil {
Fail(err.Error())
}
}(sourceFile)

targetFile, err := os.Create(targetFilePath)
if err != nil {
return
}
defer func() {
err = targetFile.Close()
if err != nil {
Fail(err.Error())
}
}()

if _, err = io.Copy(targetFile, sourceFile); err != nil {
return
}

err = os.Chmod(targetFilePath, os.FileMode(files.WritePermission))

return
}
4 changes: 3 additions & 1 deletion embedding/orchestration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import (

"embed-code/embed-code-go/configuration"
"embed-code/embed-code-go/embedding/parsing"
"embed-code/embed-code-go/fragmentation"
"embed-code/embed-code-go/logging"

"github.com/bmatcuk/doublestar/v4"
Expand Down Expand Up @@ -158,8 +159,9 @@ func processRequiredDocs(
}

var processingErrors []error
resolver := fragmentation.NewResolver()
for _, doc := range requiredDocPaths {
processor := newProcessor(doc, config, parsing.Transitions, requiredDocPaths)
processor := newProcessor(doc, config, parsing.Transitions, requiredDocPaths, resolver)
if err := handle(doc, processor); err != nil {
processingErrors = append(processingErrors, err)
}
Expand Down
Loading
Loading