added --sort keys

Author: egandro

.github/workflows/golang.yml

@@ -57,3 +57,6 @@ jobs:
     - name: Test
       run: go test -v -coverprofile=coverage.out ./...
       working-directory: ./golang
+
+    - name: Run Integration Test
+      run: bash ./test-dummy.sh

golang/main.go

@@ -2,40 +2,88 @@ package main
 
 import (
 	"encoding/json"
+	"flag"
 	"fmt"
 	"io"
 	"os"
 
 	"github.com/WebReflection/flatted/golang/pkg/flatted"
 )
 
-func main() {
-	stat, _ := os.Stdin.Stat()
-	if (stat.Mode() & os.ModeCharDevice) != 0 {
-		fmt.Fprintln(os.Stderr, "Usage: echo <circular-json> | flatted")
-		os.Exit(1)
+// flatten reads standard JSON from r and writes flatted JSON to w.
+func flatten(r io.Reader, w io.Writer) error {
+	input, err := io.ReadAll(r)
+	if err != nil {
+		return err
 	}
-
-	input, err := io.ReadAll(os.Stdin)
+	var data any
+	if err := json.Unmarshal(input, &data); err != nil {
+		return fmt.Errorf("invalid JSON input: %w", err)
+	}
+	s, err := flatted.Stringify(data, nil, nil)
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "Error reading input: %v\n", err)
-		os.Exit(1)
+		return err
 	}
+	fmt.Fprintln(w, s)
+	return nil
+}
 
-	// Parse the flatted input
+// unflatten reads flatted JSON from r and writes standard JSON to w.
+func unflatten(r io.Reader, w io.Writer) error {
+	input, err := io.ReadAll(r)
+	if err != nil {
+		return err
+	}
 	parsed, err := flatted.Parse(string(input), nil)
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "Error parsing flatted data: %v\n", err)
-		os.Exit(1)
+		return fmt.Errorf("invalid flatted input: %w", err)
 	}
-
-	// Convert to standard JSON for output.
-	// Note: If the revived object is still circular, json.Marshal will error.
 	output, err := json.MarshalIndent(parsed, "", "  ")
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "Error marshaling to JSON: %v\n", err)
-		os.Exit(1)
+		return err
 	}
+	fmt.Fprintln(w, string(output))
+	return nil
+}
 
-	fmt.Println(string(output))
+func main() {
+	var decompress bool
+	flag.BoolVar(&decompress, "d", false, "decompress (unflatten)")
+	flag.BoolVar(&decompress, "decompress", false, "decompress (unflatten)")
+	flag.BoolVar(&decompress, "unflatten", false, "decompress (unflatten)")
+
+	flag.Usage = func() {
+		fmt.Fprintf(os.Stderr, "Usage: %s [OPTION]... [FILE]\n", os.Args[0])
+		fmt.Fprintln(os.Stderr, "Flatten or unflatten circular JSON structures.")
+		fmt.Fprintln(os.Stderr, "")
+		fmt.Fprintln(os.Stderr, "Options:")
+		flag.PrintDefaults()
+		fmt.Fprintln(os.Stderr, "")
+		fmt.Fprintln(os.Stderr, "If no FILE is provided, or if FILE is -, read from standard input.")
+	}
+
+	flag.Parse()
+
+	var r io.Reader = os.Stdin
+	if flag.NArg() > 0 && flag.Arg(0) != "-" {
+		f, err := os.Open(flag.Arg(0))
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "%s: %v\n", os.Args[0], err)
+			os.Exit(1)
+		}
+		defer f.Close()
+		r = f
+	}
+
+	var err error
+	if decompress {
+		err = unflatten(r, os.Stdout)
+	} else {
+		err = flatten(r, os.Stdout)
+	}
+
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "%s: %v\n", os.Args[0], err)
+		os.Exit(1)
+	}
 }

test-dummy.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+# 1) Go to the golang directory and run a make build
+echo "Building flatted binary..."
+cd golang || exit 1
+make build || exit 1
+cd ..
+
+# 2) normalize sha256sum test/65518.json and verify the hash
+ORIGINAL_HASH="c76a5329a11de440d28f8d8c4b37aafaa61bca9f1eb41a904b3d46312d5ab565"
+ACTUAL_HASH=$(cat test/65518.json | jq --sort-keys -r . | sha256sum | awk '{ print $1 }')
+
+echo "Verifying checksum for test/65518.json..."
+if [ "$ACTUAL_HASH" == "$ORIGINAL_HASH" ]; then
+    echo "Checksum verified successfully."
+else
+    echo "Checksum mismatch!"
+    echo "Expected: $ORIGINAL_HASH"
+    echo "Actual:   $ACTUAL_HASH"
+    exit 1
+fi
+
+# 3) Create a temp file, flatten the input, and verify the output hash
+TEMP_FILE=$(mktemp)
+trap 'rm -f "$TEMP_FILE"' EXIT
+
+echo "Flattening test/65518.json and verifying output..."
+cat test/65518.json | ./golang/flatted | jq --sort-keys -r . > "$TEMP_FILE"
+
+EXPECTED_OUTPUT_HASH="feacd401744cea2e8597b41ddb3bad1fe6e77e306979529ddea9bc72e3f30a14"
+ACTUAL_OUTPUT_HASH=$(sha256sum "$TEMP_FILE" | awk '{ print $1 }')
+
+if [ "$ACTUAL_OUTPUT_HASH" == "$EXPECTED_OUTPUT_HASH" ]; then
+    echo "Output checksum verified successfully."
+else
+    echo "Output checksum mismatch!"
+    echo "Expected: $EXPECTED_OUTPUT_HASH"
+    echo "Actual:   $ACTUAL_OUTPUT_HASH"
+    exit 1
+fi
+
+# 4) Unflatten the temp file and verify it matches the original normalized hash
+echo "Unflattening and verifying round-trip integrity..."
+ROUNDTRIP_HASH=$(cat "$TEMP_FILE" | ./golang/flatted -d | jq --sort-keys -r . | sha256sum | awk '{ print $1 }')
+
+if [ "$ROUNDTRIP_HASH" == "$ORIGINAL_HASH" ]; then
+    echo "Round-trip verification successful."
+else
+    echo "Round-trip verification failed!"
+    echo "Expected: $ORIGINAL_HASH"
+    echo "Actual:   $ROUNDTRIP_HASH"
+    exit 1
+fi