fix: add tests (#16)

Adding some tests to ensure:

- The generated output matches what is currently expected.
- Output is consistent with the AEP linter (this is disabled until aep-dev/api-linter#86 is merged).

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.22.3
+
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Verify no change to generated files.
+        run: |
+          go install github.com/bufbuild/buf/cmd/[email protected]
+          ./scripts/verify-goldens.sh
+
+      # - name: Run script
+      #   run: |
+      #     ./scripts/run-api-linter.sh

parser/parser.go

@@ -30,6 +30,11 @@ type ParsedResource struct {
 	Parents []*ParsedResource
 }
 
+type ParsedProperty struct {
+	*schema.Property
+	Name string
+}
+
 func NewParsedService(s *schema.Service) (*ParsedService, error) {
 	resourceByType, err := loadResourceByType(s)
 	if err != nil {
@@ -80,6 +85,17 @@ func addGetToResource(pr *ParsedResource) {
 	}
 }
 
+func (r *ParsedResource) GetFieldsSortedByNumber() []*ParsedProperty {
+	fields := []*ParsedProperty{}
+	for name, p := range r.Properties {
+		fields = append(fields, &ParsedProperty{
+			Property: p,
+			Name:     name,
+		})
+	}
+	return fields
+}
+
 // add an id field to the resource.
 // TODO(yft): this has to be reconciled with the
 // existence of path.

schema/resourcedefinition.proto

@@ -51,7 +51,7 @@ enum Type {
 
 message Property {
   Type type = 1;
- // field number used for protobuf or other systems where fields must
+  // field number used for protobuf or other systems where fields must
   // be explicitly enumerated.
   int32 number = 2;
   bool readOnly = 3;

scripts/run-api-linter.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+set -e
 
 if ! which api-linter ; then
     go install github.com/aep-dev/api-linter/cmd/api-linter@latest
@@ -10,4 +11,5 @@ fi
 
 api-linter \
     ./example/bookstore/v1/bookstore.proto \
-    -I /tmp/googleapis
+    -I /tmp/googleapis \
+    --set-exit-status

scripts/verify-goldens.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -e
+./scripts/regenerate-all.sh
+if git diff --exit-code; then
+    echo "No differences found."
+else
+    echo "Differences found.";
+    exit 1;
+fi

writer/proto/resource.go

@@ -91,15 +91,15 @@ func AddResource(r *parser.ParsedResource, fb *builder.FileBuilder, sb *builder.
 // GenerateResourceMesssage adds the resource message.
 func GeneratedResourceMessage(r *parser.ParsedResource) (*builder.MessageBuilder, error) {
 	mb := builder.NewMessage(r.Kind)
-	for n, p := range r.Properties {
+	for _, p := range r.GetFieldsSortedByNumber() {
 		typ := builder.FieldTypeBool()
 		switch p.Type {
 		case schema.Type_STRING:
 			typ = builder.FieldTypeString()
 		}
-		mb.AddField(builder.NewField(n, typ).SetNumber(p.Number).SetComments(
+		mb.AddField(builder.NewField(p.Name, typ).SetNumber(p.Number).SetComments(
 			builder.Comments{
-				LeadingComment: fmt.Sprintf("Field for %v.", n),
+				LeadingComment: fmt.Sprintf("Field for %v.", p.Name),
 			},
 		))
 	}