interim

Author: dnitsch

.gitignore

@@ -15,8 +15,11 @@
 *.out
 
 # Dependency directories (remove the comment below to include it)
-# vendor/
+vendor/
 
 # Go workspace file
 go.work
 **/.ignore*
+.coverage
+
+.DS_Store

Makefile

@@ -0,0 +1,52 @@
+OWNER = dnitsch
+NAME := async-api-generator
+GIT_TAG := "0.0.0"
+VERSION := "v$(GIT_TAG)"
+REVISION := "aaaabbbb"
+
+LDFLAGS := -ldflags="-s -w -X \"github.com/$(OWNER)/$(NAME)/cmd.Version=$(VERSION)\" -X \"github.com/$(OWNER)/$(NAME)/cmd.Revision=$(REVISION)\" -extldflags -static"
+
+install:
+	go mod tidy
+	go mod vendor
+	
+install_ci:
+	go mod vendor
+
+.PHONY: clean
+clean:
+	rm -rf bin/*
+	rm -rf dist/*
+	rm -rf vendor/*
+	mkdir -p dist
+
+bingen:
+	for os in darwin linux windows; do \
+		GOOS=$$os CGO_ENABLED=0 go build -mod=readonly -buildvcs=false $(LDFLAGS) -o dist/$(NAME)-$$os ./cmd; \
+	done
+
+build: clean install bingen
+
+build_ci: clean install_ci bingen
+
+cross-build: bingen
+
+tag: 
+	git tag -a $(VERSION) -m "ci tag release" $(REVISION)
+	git push origin $(VERSION)
+
+release:
+	OWNER=$(OWNER) NAME=$(NAME) PAT=$(PAT) VERSION=$(VERSION) . hack/release.sh 
+
+test_prereq: 
+	mkdir -p .coverage
+	go install github.com/jstemmer/go-junit-report/v2@latest && \
+	go install github.com/axw/gocov/gocov@latest && \
+	go install github.com/AlekSi/gocov-xml@latest
+
+test: test_prereq
+	go test ./... -v -mod=readonly -race -coverprofile=.coverage/out | go-junit-report > .coverage/report-junit.xml && \
+	gocov convert .coverage/out | gocov-xml > .coverage/report-cobertura.xml
+
+coverage: test
+	go tool cover -html=.coverage/out

README.md

@@ -27,3 +27,25 @@ Special consideration will need to be given to files that are not able to contai
 Not using an existing parser generator like CGF, BNF, or EBNF is on purposes as the input source will only ever really be composed of parts we care about i.e. `gendoc` markers their beginning and end and what they enclose within them as text.
 
 We'll use the overly simplified Pratt Parser (top down method) as we'll have no need to for expression parsing onyl statement node creation with the associated/helper attributes.
+
+## AsyncAPI standard
+
+The current [AsyncAPI standard spec](https://www.asyncapi.com/docs/reference/specification/v2.6.0) is at version `2.6.0`.
+
+The tool will deal with all the relevant sections to be able to build an AsyncAPI spec file from within a single repo.
+
+The asyncAPI is built from the `Application` - i.e. service down, each service will have a toplevel description - `info` key, which will in turn include 
+
+### Important Properties
+
+- `id` name of the service. Will default to parent folder name - unless overridden
+    - format:  `urn:$business_domain:$bounded_context_domain:$service_name` => `urn:whds:packing:whds.packing.app`
+- `application` 
+    this is info about the service/application including descriptions and titles
+- `channels` outlines the topics/subscriptions or queues the application produces or is subscribed to.
+    - `topic/queue/subscription`
+        will each contain a message summary description, schema, any traits - i.e. re-useable components - such as the envelop for common parameters
+
+### EventCatalog binding
+
+The translation of AsyncAPI into an EventCatalog set up. Whilst there are fairly standard mappings between the 2 processes - there are some nuances and requirements.

hack/boilerplate.go.txt

@@ -0,0 +1,6 @@
+/*
+
+Copyright DNITSCH - WTFPL
+
+*/
+

hack/release.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+id=$(curl -X POST -u $OWNER:$PAT -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/$OWNER/$NAME/releases -d "{\"tag_name\":\"$VERSION\",\"generate_release_notes\":true,\"prerelease\":false}" | jq -r .id)
+
+upload_url=https://uploads.github.com/repos/$OWNER/$NAME/releases/$id/assets
+
+for asset in dist/*; do \
+    name=$(echo $asset | cut -c 6-)
+    curl -u $OWNER:$PAT -H "Content-Type: application/x-binary" -X POST --data-binary "@$asset" "$upload_url?name=$name"
+done

internal/cmdutil/cmdutil.go

@@ -0,0 +1,33 @@
+package cmdutil
+
+import (
+	"io/fs"
+	"path/filepath"
+	"strings"
+)
+
+type FileList struct {
+	Name string // fullname of file
+	Path string // full path to file - either relative or full
+	Type string // type of file e.g. schema json, CS, TF, K8sYaml, HelmYaml
+}
+
+func ListFiles(baseDir string) ([]*FileList, error) {
+	// init a
+	files := []*FileList{}
+	if err := filepath.WalkDir(baseDir, func(path string, d fs.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+
+		if !d.IsDir() {
+			files = append(files, &FileList{Name: d.Name(), Path: path, Type: strings.TrimPrefix(filepath.Ext(path), ".")})
+			return nil
+		}
+		return nil
+	}); err != nil {
+		// return nil - even if some files were processed
+		return nil, err
+	}
+	return files, nil
+}

internal/cmdutil/cmdutil_test.go

@@ -0,0 +1,47 @@
+package cmdutil_test
+
+import (
+	"os"
+	"strings"
+	"testing"
+
+	"github.com/dnitsch/async-api-generator/internal/cmdutil"
+)
+
+func Test_ListFiles_in_mock_directort(t *testing.T) {
+	baseDir := "./test/samples"
+	// debug test purposes only
+	cwd, err := os.Getwd()
+	if err != nil {
+		t.Fatal(err)
+	}
+	if strings.Contains(cwd, "internal/cmdutil") {
+		baseDir = "../../test/samples"
+	}
+	// END DEBUG
+	got, err := cmdutil.ListFiles(baseDir)
+	if err != nil {
+		t.Fatalf("%v", err)
+	}
+	ttests := []struct {
+		expectName string
+		expectPath string
+		expectType string
+	}{
+		{"sample.cs", "../../test/samples/business/sample.cs", "cs"},
+		{"index.md", "../../test/samples/index.md", "md"},
+		{"sample.tf", "../../test/samples/infra/sample.tf", "tf"},
+	}
+	for idx, tt := range ttests {
+		gotLf := got[idx]
+		if gotLf.Name != tt.expectName {
+			t.Errorf("expected names of files to be equal. got: %s, wanted: %s", gotLf.Name, tt.expectName)
+		}
+		if gotLf.Path != tt.expectPath {
+			t.Errorf("expected path of files to be equal. got: %s, wanted: %s", gotLf.Path, tt.expectPath)
+		}
+		if gotLf.Type != tt.expectType {
+			t.Errorf("expected types of files to be equal. got: %s, wanted: %s", gotLf.Type, tt.expectType)
+		}
+	}
+}

pkg/crawl/crawl.go

@@ -0,0 +1,3 @@
+
+package crawl
+

pkg/crawl/crawl_test.go

@@ -0,0 +1,18 @@
+package crawl_test
+
+import "testing"
+
+func Test_Crawl_single_file_input(t *testing.T) {
+	ttests := map[string]struct {
+		objType any
+	}{
+		"test1": {
+			objType: nil,
+		},
+	}
+	for name, tt := range ttests {
+		t.Run(name, func(t *testing.T) {
+			_ = tt
+		})
+	}
+}

pkg/lexer/lexer.go

@@ -8,8 +8,8 @@ import (
 
 const (
 	// Literals
-	BEGIN_DOC string = " gendoc"
-	END_DOC   string = " !gendoc"
+	BEGIN_DOC string = "+gendoc"
+	END_DOC   string = "-gendoc"
 )
 
 // nonText characters captures all character sets that are _not_ assignable to TEXT
@@ -40,10 +40,10 @@ func (l *Lexer) NextToken() token.Token {
 			// if next rune is a `/` then we have to consume it from lexer
 			l.readChar()
 			if l.peekIsDocGenBegin() {
-				tok = l.readDocAnnotation(token.Token{Type: token.BEGIN_DOC_GEN, Literal: "// gendoc"})
+				tok = l.readDocAnnotation(token.Token{Type: token.BEGIN_DOC_GEN, Literal: "//+gendoc"})
 				// return l.readDocAnnotation(token.Token{Type: token.BEGIN_DOC_GEN, Literal: "// gendoc"})
 			} else if l.peekIsDocGenEnd() {
-				tok = token.Token{Type: token.END_DOC_GEN, Literal: "// !gendoc"}
+				tok = token.Token{Type: token.END_DOC_GEN, Literal: "//-gendoc"}
 			} else {
 				// it is not a doc gen marker assigning double slash as text
 				tok = token.Token{Type: token.TEXT, Literal: "//"}
@@ -105,11 +105,11 @@ func (l *Lexer) setTextSeparatorToken() token.Token {
 // readDocAnnotation reads the rest of the line identified by
 func (l *Lexer) readDocAnnotation(tok token.Token) token.Token {
 	metaTag := ""
-	for l.ch != '\n' {
+	for l.peekChar() != '\n' {
 		metaTag += string(l.peekChar())
 		l.readChar()
 	}
-	tok.MetaTags = strings.TrimSpace(metaTag)
+	tok.MetaAnnotation = strings.TrimSpace(metaTag)
 	return tok
 }
 
@@ -134,7 +134,7 @@ func (l *Lexer) peekIsDocGenBegin() bool {
 func (l *Lexer) peekIsDocGenEnd() bool {
 	count := 0
 	docGen := ""
-	for count < 8 {
+	for count < 7 {
 		count++
 		docGen += string(l.peekChar())
 		l.readChar()

pkg/lexer/lexer_test.go

@@ -1,8 +1,6 @@
 package lexer_test
 
 import (
-	"fmt"
-	"strings"
 	"testing"
 
 	"github.com/dnitsch/async-api-generator/pkg/lexer"
@@ -11,11 +9,11 @@ import (
 
 func Test(t *testing.T) {
 	input := `foo stuyfsdfsf
-// gendoc type=message,subtype=example,consumer=[],producer=[]
+//+gendoc type=message,subtype=example,consumer=[],producer=[]
 class {
 	stuff string {get; set;}
 }
-// !gendoc
+//-gendoc
 
 /// <summary> ignorethis
 # another comment
@@ -28,7 +26,8 @@ class {
 		{token.SPACE, " "},
 		{token.TEXT, "stuyfsdfsf"},
 		{token.NEW_LINE, "\n"},
-		{token.BEGIN_DOC_GEN, "// gendoc"},
+		{token.BEGIN_DOC_GEN, "//+gendoc"},
+		{token.NEW_LINE, "\n"},
 		{token.TEXT, "class"},
 		{token.SPACE, " "},
 		{token.TEXT, "{"},
@@ -44,7 +43,7 @@ class {
 		{token.NEW_LINE, "\n"},
 		{token.TEXT, "}"},
 		{token.NEW_LINE, "\n"},
-		{token.END_DOC_GEN, "// !gendoc"},
+		{token.END_DOC_GEN, "//-gendoc"},
 		{token.NEW_LINE, "\n"},
 		{token.NEW_LINE, "\n"},
 		{token.TEXT, "//"},
@@ -66,7 +65,6 @@ class {
 	for i, tt := range ttests {
 
 		tok := l.NextToken()
-		fmt.Println(tok)
 		if tok.Type != tt.expectedType {
 			t.Fatalf("tests[%d] - tokentype wrong. got=%q, expected=%q",
 				i, tok.Type, tt.expectedType)
@@ -76,9 +74,8 @@ class {
 			t.Fatalf("tests[%d] - literal wrong. got=%q, expected=%q",
 				i, tok.Literal, tt.expectedLiteral)
 		}
-		if tok.Type == token.BEGIN_DOC_GEN && len(tok.MetaTags) < 1 && strings.EqualFold(tok.MetaTags, " type=message,subtype=example,consumer=[],producer=[]\n") {
-			// if tok.MetaTags
-			t.Errorf("gendoc token should include ")
+		if tok.Type == token.BEGIN_DOC_GEN && len(tok.MetaAnnotation) < 1 && tok.MetaAnnotation != "type=message,subtype=example,consumer=[],producer=[]" {
+			t.Errorf("gendoc meta annotation should include %s", "type=message,subtype=example,consumer=[],producer=[]")
 		}
 	}
 }

pkg/ast/ast.go renamed to pkg/parser/ast.go

@@ -1,4 +1,4 @@
-package ast
+package parser
 
 import (
 	"bytes"
@@ -34,9 +34,8 @@ type GenDoc struct {
 func (p *GenDoc) TokenLiteral() string {
 	if len(p.Statements) > 0 {
 		return p.Statements[0].TokenLiteral()
-	} else {
-		return ""
 	}
+	return ""
 }
 
 func (p *GenDoc) String() string {
@@ -49,10 +48,18 @@ func (p *GenDoc) String() string {
 	return out.String()
 }
 
-/*
- * Statements will encapsulate expressions so they can be later evaluated
- */
+type ContentType string 
+
+const (
+
+)
+
+type GenDocMetaAnnotation struct {
+	Type ContentType
+}
+
 // GenDocStatement
+// Statements will encapsulate expressions so they can be later evaluated
 type GenDocStatement struct {
 	Token token.Token // token.BEGIN_GEN_DOC token
 	Name  *EnclosedIdentifier
@@ -65,7 +72,7 @@ func (ls *GenDocStatement) String() string {
 	var out bytes.Buffer
 
 	out.WriteString(ls.TokenLiteral())
-	out.WriteString(fmt.Sprintf("%s %s", ls.Name.String(), ls.Token.MetaTags))
+	out.WriteString(fmt.Sprintf("%s %s", ls.Name.String(), ls.Token.MetaAnnotation))
 
 	if ls.Value != nil {
 		out.WriteString(ls.Value.String())