Merge pull request #2138 from kushal9897/fix/json-array-error-message

Improve error message for top-level arrays

Author: felixfontein

stores/json/store.go

@@ -258,10 +258,10 @@ func (store Store) treeBranchFromJSON(in []byte) (sops.TreeBranch, error) {
 	}
 	if delim, ok := value.(json.Delim); ok {
 		if delim.String() != "{" {
-			return nil, fmt.Errorf("Expected JSON object start, got delimiter %s instead", value)
+			return nil, fmt.Errorf("SOPS only supports JSON files with a top-level object (starting with '{'), not arrays or other types. Got delimiter %s instead. To encrypt this file, wrap it in an object, e.g., {\"data\": [...]}", value)
 		}
 	} else {
-		return nil, fmt.Errorf("Expected JSON object start, got %#v of type %T instead", value, value)
+		return nil, fmt.Errorf("SOPS only supports JSON files with a top-level object (starting with '{'), not other JSON types. Got %#v of type %T instead", value, value)
 	}
 	return store.treeBranchFromJSONDecoder(dec)
 }

stores/json/store_test.go

@@ -132,14 +132,14 @@ func TestDecodeNumber(t *testing.T) {
 	in := `42`
 	_, err := Store{}.treeBranchFromJSON([]byte(in))
 	assert.NotNil(t, err)
-	assert.Equal(t, "Expected JSON object start, got 42 of type float64 instead", err.Error())
+	assert.Equal(t, "SOPS only supports JSON files with a top-level object (starting with '{'), not other JSON types. Got 42 of type float64 instead", err.Error())
 }
 
 func TestDecodeArray(t *testing.T) {
 	in := ` [42] `
 	_, err := Store{}.treeBranchFromJSON([]byte(in))
 	assert.NotNil(t, err)
-	assert.Equal(t, "Expected JSON object start, got delimiter [ instead", err.Error())
+	assert.Equal(t, "SOPS only supports JSON files with a top-level object (starting with '{'), not arrays or other types. Got delimiter [ instead. To encrypt this file, wrap it in an object, e.g., {\"data\": [...]}", err.Error())
 }
 
 func TestDecodeEmpty(t *testing.T) {