Compare commits
17 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e561c153ef | |||
| 1ac4431db9 | |||
| cad7681abe | |||
| 04f7e836d4 | |||
| 58cf71231f | |||
| 25efc11803 | |||
| 2336b98a36 | |||
| e0ceae2490 | |||
| 20a7856820 | |||
| 478c2ff9d8 | |||
| 16b1ef5508 | |||
| e14bde7c1d | |||
| 4b1ff01eb3 | |||
| 048a25f0f2 | |||
| b3575580f9 | |||
| a0be52f4c1 | |||
| 316bfc66a4 |
@@ -0,0 +1,25 @@
|
|||||||
|
name: capabilities
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- v2
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- v2
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
check:
|
||||||
|
name: check capabilities
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- name: Setup go
|
||||||
|
uses: actions/setup-go@v6
|
||||||
|
with:
|
||||||
|
go-version: "1.26"
|
||||||
|
- name: Install capslock
|
||||||
|
run: go install github.com/google/capslock/cmd/capslock@latest
|
||||||
|
- name: Check for new capabilities
|
||||||
|
run: ./caps.sh check
|
||||||
@@ -19,7 +19,7 @@ jobs:
|
|||||||
dry-run: false
|
dry-run: false
|
||||||
language: go
|
language: go
|
||||||
- name: Upload Crash
|
- name: Upload Crash
|
||||||
uses: actions/upload-artifact@v6
|
uses: actions/upload-artifact@v7
|
||||||
if: failure() && steps.build.outcome == 'success'
|
if: failure() && steps.build.outcome == 'success'
|
||||||
with:
|
with:
|
||||||
name: artifacts
|
name: artifacts
|
||||||
|
|||||||
@@ -15,6 +15,6 @@ jobs:
|
|||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@v6
|
uses: actions/setup-go@v6
|
||||||
with:
|
with:
|
||||||
go-version: "1.25"
|
go-version: "1.26"
|
||||||
- name: Run tests with coverage
|
- name: Run tests with coverage
|
||||||
run: ./ci.sh coverage -d "${GITHUB_BASE_REF-HEAD}"
|
run: ./ci.sh coverage -d "${GITHUB_BASE_REF-HEAD}"
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ jobs:
|
|||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@v3
|
uses: docker/setup-buildx-action@v4
|
||||||
|
|
||||||
- name: Run Go versions compatibility test
|
- name: Run Go versions compatibility test
|
||||||
run: |
|
run: |
|
||||||
@@ -28,7 +28,7 @@ jobs:
|
|||||||
./test-go-versions.sh --output ./test-results $VERSIONS
|
./test-go-versions.sh --output ./test-results $VERSIONS
|
||||||
|
|
||||||
- name: Upload test results
|
- name: Upload test results
|
||||||
uses: actions/upload-artifact@v6
|
uses: actions/upload-artifact@v7
|
||||||
with:
|
with:
|
||||||
name: go-versions-test-results
|
name: go-versions-test-results
|
||||||
path: |
|
path: |
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ jobs:
|
|||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@v6
|
uses: actions/setup-go@v6
|
||||||
with:
|
with:
|
||||||
go-version: "1.24"
|
go-version: "1.26"
|
||||||
- name: Run golangci-lint
|
- name: Run golangci-lint
|
||||||
uses: golangci/golangci-lint-action@v9
|
uses: golangci/golangci-lint-action@v9
|
||||||
with:
|
with:
|
||||||
|
|||||||
@@ -22,15 +22,15 @@ jobs:
|
|||||||
- name: Set up Go
|
- name: Set up Go
|
||||||
uses: actions/setup-go@v6
|
uses: actions/setup-go@v6
|
||||||
with:
|
with:
|
||||||
go-version: "1.25"
|
go-version: "1.26"
|
||||||
- name: Login to GitHub Container Registry
|
- name: Login to GitHub Container Registry
|
||||||
uses: docker/login-action@v3
|
uses: docker/login-action@v4
|
||||||
with:
|
with:
|
||||||
registry: ghcr.io
|
registry: ghcr.io
|
||||||
username: ${{ github.actor }}
|
username: ${{ github.actor }}
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
- name: Run GoReleaser
|
- name: Run GoReleaser
|
||||||
uses: goreleaser/goreleaser-action@v6
|
uses: goreleaser/goreleaser-action@v7
|
||||||
with:
|
with:
|
||||||
distribution: goreleaser
|
distribution: goreleaser
|
||||||
version: '~> v2'
|
version: '~> v2'
|
||||||
|
|||||||
@@ -10,9 +10,10 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
strategy:
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [ 'ubuntu-latest', 'windows-latest', 'macos-latest', 'macos-14' ]
|
os: [ 'ubuntu-latest', 'windows-latest', 'macos-latest', 'macos-14' ]
|
||||||
go: [ '1.24', '1.25' ]
|
go: [ '1.25', '1.26' ]
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
name: ${{ matrix.go }}/${{ matrix.os }}
|
name: ${{ matrix.go }}/${{ matrix.os }}
|
||||||
steps:
|
steps:
|
||||||
|
|||||||
@@ -22,7 +22,6 @@ builds:
|
|||||||
- linux_riscv64
|
- linux_riscv64
|
||||||
- windows_amd64
|
- windows_amd64
|
||||||
- windows_arm64
|
- windows_arm64
|
||||||
- windows_arm
|
|
||||||
- darwin_amd64
|
- darwin_amd64
|
||||||
- darwin_arm64
|
- darwin_arm64
|
||||||
- id: tomljson
|
- id: tomljson
|
||||||
@@ -42,7 +41,6 @@ builds:
|
|||||||
- linux_riscv64
|
- linux_riscv64
|
||||||
- windows_amd64
|
- windows_amd64
|
||||||
- windows_arm64
|
- windows_arm64
|
||||||
- windows_arm
|
|
||||||
- darwin_amd64
|
- darwin_amd64
|
||||||
- darwin_arm64
|
- darwin_arm64
|
||||||
- id: jsontoml
|
- id: jsontoml
|
||||||
@@ -62,7 +60,6 @@ builds:
|
|||||||
- linux_arm
|
- linux_arm
|
||||||
- windows_amd64
|
- windows_amd64
|
||||||
- windows_arm64
|
- windows_arm64
|
||||||
- windows_arm
|
|
||||||
- darwin_amd64
|
- darwin_amd64
|
||||||
- darwin_arm64
|
- darwin_arm64
|
||||||
universal_binaries:
|
universal_binaries:
|
||||||
|
|||||||
@@ -53,6 +53,14 @@ go-toml is a TOML library for Go. The goal is to provide an easy-to-use and effi
|
|||||||
- Commit messages must explain **why** the change is needed
|
- Commit messages must explain **why** the change is needed
|
||||||
- Keep messages clear and informative even if details are in the PR description
|
- Keep messages clear and informative even if details are in the PR description
|
||||||
|
|
||||||
|
### Capabilities
|
||||||
|
|
||||||
|
go-toml tracks system-level capabilities using [capslock](https://github.com/google/capslock). The baseline is in `capability_baseline.txt` and CI enforces that it does not grow.
|
||||||
|
|
||||||
|
- **Do not introduce new capabilities.** PRs that increase the capability set (e.g., adding network access, subprocess execution, syscalls) are unlikely to be accepted.
|
||||||
|
- If a change causes the capabilities check to fail, do not update the baseline to make it pass. Instead, rethink the approach to avoid requiring new capabilities.
|
||||||
|
- To check locally: `./caps.sh check` (requires `capslock` installed via `go install github.com/google/capslock/cmd/capslock@latest`)
|
||||||
|
|
||||||
## Pull Request Checklist
|
## Pull Request Checklist
|
||||||
|
|
||||||
Before submitting:
|
Before submitting:
|
||||||
@@ -61,4 +69,5 @@ Before submitting:
|
|||||||
2. No backward-incompatible changes (unless discussed)
|
2. No backward-incompatible changes (unless discussed)
|
||||||
3. Relevant documentation added/updated
|
3. Relevant documentation added/updated
|
||||||
4. No performance regression (verify with benchmarks)
|
4. No performance regression (verify with benchmarks)
|
||||||
5. Title is clear and understandable for changelog
|
5. Capabilities are not increasing (`./caps.sh check`)
|
||||||
|
6. Title is clear and understandable for changelog
|
||||||
|
|||||||
@@ -180,6 +180,25 @@ description. Pull requests that lower performance will receive more scrutiny.
|
|||||||
|
|
||||||
[benchstat]: https://pkg.go.dev/golang.org/x/perf/cmd/benchstat
|
[benchstat]: https://pkg.go.dev/golang.org/x/perf/cmd/benchstat
|
||||||
|
|
||||||
|
### Capabilities
|
||||||
|
|
||||||
|
We use [capslock](https://github.com/google/capslock) to track what
|
||||||
|
system-level capabilities (file access, network, syscalls, etc.) each package
|
||||||
|
requires. The current baseline is in `capability_baseline.txt`. CI will fail if
|
||||||
|
a change introduces a new capability.
|
||||||
|
|
||||||
|
**Pull requests that increase the set of capabilities are unlikely to be
|
||||||
|
accepted.** go-toml is a parsing library and should not need network access,
|
||||||
|
subprocess execution, or other capabilities beyond what it already uses.
|
||||||
|
|
||||||
|
If you believe a new capability is genuinely needed, discuss it in an issue
|
||||||
|
first. To update the baseline after approval:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go install github.com/google/capslock/cmd/capslock@latest
|
||||||
|
./caps.sh generate
|
||||||
|
```
|
||||||
|
|
||||||
### Style
|
### Style
|
||||||
|
|
||||||
Try to look around and follow the same format and structure as the rest of the
|
Try to look around and follow the same format and structure as the rest of the
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
github.com/pelletier/go-toml/v2: CAPABILITY_REFLECT, CAPABILITY_UNANALYZED, CAPABILITY_UNSAFE_POINTER
|
||||||
@@ -0,0 +1,101 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
#
|
||||||
|
# Generates or checks the capability baseline for go-toml.
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
# ./caps.sh generate # regenerate capability_baseline.txt
|
||||||
|
# ./caps.sh check # check that capabilities haven't grown
|
||||||
|
#
|
||||||
|
# Requires: go, capslock (go install github.com/google/capslock/cmd/capslock@latest)
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
BASELINE="capability_baseline.txt"
|
||||||
|
CAPSLOCK="${CAPSLOCK:-capslock}"
|
||||||
|
|
||||||
|
# Capabilities that must never appear in any package.
|
||||||
|
FORBIDDEN_CAPS=(
|
||||||
|
CAPABILITY_NETWORK
|
||||||
|
CAPABILITY_CGO
|
||||||
|
CAPABILITY_EXEC
|
||||||
|
)
|
||||||
|
|
||||||
|
capslock_to_baseline() {
|
||||||
|
"$CAPSLOCK" -packages=. -output=package -granularity=package \
|
||||||
|
| jq -r 'to_entries | sort_by(.key) | .[] | .key + ": " + (.value | sort | join(", "))'
|
||||||
|
}
|
||||||
|
|
||||||
|
generate() {
|
||||||
|
capslock_to_baseline > "$BASELINE"
|
||||||
|
echo "Wrote $BASELINE"
|
||||||
|
}
|
||||||
|
|
||||||
|
check() {
|
||||||
|
if [ ! -f "$BASELINE" ]; then
|
||||||
|
echo "ERROR: $BASELINE not found. Run '$0 generate' first."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
current=$(mktemp)
|
||||||
|
trap 'rm -f "$current"' EXIT
|
||||||
|
|
||||||
|
capslock_to_baseline > "$current"
|
||||||
|
|
||||||
|
failed=0
|
||||||
|
|
||||||
|
# Check for forbidden capabilities in current output.
|
||||||
|
for cap in "${FORBIDDEN_CAPS[@]}"; do
|
||||||
|
if grep -q "$cap" "$current"; then
|
||||||
|
echo "FORBIDDEN capability found: $cap"
|
||||||
|
grep "$cap" "$current"
|
||||||
|
failed=1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# Extract all unique capability names from baseline and current.
|
||||||
|
baseline_caps=$(grep -oE 'CAPABILITY_[A-Z_]+' "$BASELINE" | sort -u)
|
||||||
|
current_caps=$(grep -oE 'CAPABILITY_[A-Z_]+' "$current" | sort -u)
|
||||||
|
|
||||||
|
# Check for new capability names not in the baseline.
|
||||||
|
new_caps=$(comm -13 <(echo "$baseline_caps") <(echo "$current_caps"))
|
||||||
|
if [ -n "$new_caps" ]; then
|
||||||
|
echo "NEW capabilities detected (not in baseline):"
|
||||||
|
echo "$new_caps"
|
||||||
|
failed=1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check for new per-package capabilities (a package gained a capability it didn't have before).
|
||||||
|
while IFS=': ' read -r pkg caps; do
|
||||||
|
baseline_pkg_caps=$(grep "^${pkg}:" "$BASELINE" 2>/dev/null | sed 's/^[^:]*: //' || true)
|
||||||
|
if [ -z "$baseline_pkg_caps" ]; then
|
||||||
|
echo "NEW package with capabilities: $pkg: $caps"
|
||||||
|
failed=1
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
# Check each capability in current for this package
|
||||||
|
for cap in $(echo "$caps" | tr ', ' '\n' | grep -v '^$'); do
|
||||||
|
if ! echo "$baseline_pkg_caps" | grep -q "$cap"; then
|
||||||
|
echo "NEW capability for $pkg: $cap"
|
||||||
|
failed=1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
done < "$current"
|
||||||
|
|
||||||
|
if [ "$failed" -eq 1 ]; then
|
||||||
|
echo ""
|
||||||
|
echo "FAILED: capabilities have grown."
|
||||||
|
echo "If this is intentional, run '$0 generate' and commit the updated $BASELINE."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "OK: no new capabilities detected."
|
||||||
|
}
|
||||||
|
|
||||||
|
case "${1:-}" in
|
||||||
|
generate) generate ;;
|
||||||
|
check) check ;;
|
||||||
|
*)
|
||||||
|
echo "Usage: $0 {generate|check}"
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
@@ -259,6 +259,12 @@ func TestDecodeError_Position(t *testing.T) {
|
|||||||
expectedRow: 3,
|
expectedRow: 3,
|
||||||
minCol: 5,
|
minCol: 5,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: "missing equals on last line without trailing newline",
|
||||||
|
doc: "a = 1\nb = 2\nc",
|
||||||
|
expectedRow: 3,
|
||||||
|
minCol: 1,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, e := range examples {
|
for _, e := range examples {
|
||||||
|
|||||||
+5
-4
@@ -9,7 +9,7 @@ YELLOW='\033[1;33m'
|
|||||||
BLUE='\033[0;34m'
|
BLUE='\033[0;34m'
|
||||||
NC='\033[0m' # No Color
|
NC='\033[0m' # No Color
|
||||||
|
|
||||||
# Go versions to test (1.11 through 1.25)
|
# Go versions to test (1.11 through 1.26)
|
||||||
GO_VERSIONS=(
|
GO_VERSIONS=(
|
||||||
"1.11"
|
"1.11"
|
||||||
"1.12"
|
"1.12"
|
||||||
@@ -26,6 +26,7 @@ GO_VERSIONS=(
|
|||||||
"1.23"
|
"1.23"
|
||||||
"1.24"
|
"1.24"
|
||||||
"1.25"
|
"1.25"
|
||||||
|
"1.26"
|
||||||
)
|
)
|
||||||
|
|
||||||
# Default values
|
# Default values
|
||||||
@@ -64,7 +65,7 @@ EXAMPLES:
|
|||||||
$0 # Test all Go versions in parallel
|
$0 # Test all Go versions in parallel
|
||||||
$0 --sequential # Test all Go versions sequentially
|
$0 --sequential # Test all Go versions sequentially
|
||||||
$0 1.21 1.22 1.23 # Test specific versions
|
$0 1.21 1.22 1.23 # Test specific versions
|
||||||
$0 --verbose --output ./results 1.24 1.25 # Verbose output to custom directory
|
$0 --verbose --output ./results 1.25 1.26 # Verbose output to custom directory
|
||||||
|
|
||||||
EXIT CODES:
|
EXIT CODES:
|
||||||
0 Recent Go versions pass (good compatibility)
|
0 Recent Go versions pass (good compatibility)
|
||||||
@@ -136,8 +137,8 @@ fi
|
|||||||
|
|
||||||
# Validate Go versions
|
# Validate Go versions
|
||||||
for version in "${GO_VERSIONS[@]}"; do
|
for version in "${GO_VERSIONS[@]}"; do
|
||||||
if ! [[ "$version" =~ ^1\.(1[1-9]|2[0-5])$ ]]; then
|
if ! [[ "$version" =~ ^1\.(1[1-9]|2[0-6])$ ]]; then
|
||||||
log_error "Invalid Go version: $version. Supported versions: 1.11-1.25"
|
log_error "Invalid Go version: $version. Supported versions: 1.11-1.26"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
|
|||||||
+1
-257
@@ -4554,266 +4554,10 @@ func (c *customTable873) UnmarshalTOML(data []byte) error {
|
|||||||
c.Keys = append(c.Keys, key)
|
c.Keys = append(c.Keys, key)
|
||||||
c.Values[key] = string(valueBytes)
|
c.Values[key] = string(valueBytes)
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIssue873_TableUnmarshaler(t *testing.T) {
|
|
||||||
type Config struct {
|
|
||||||
Section customTable873 `toml:"section"`
|
|
||||||
}
|
|
||||||
|
|
||||||
doc := `
|
|
||||||
[section]
|
|
||||||
key1 = "value1"
|
|
||||||
key2 = "value2"
|
|
||||||
key3 = "value3"
|
|
||||||
`
|
|
||||||
|
|
||||||
var cfg Config
|
|
||||||
err := toml.NewDecoder(bytes.NewReader([]byte(doc))).
|
|
||||||
EnableUnmarshalerInterface().
|
|
||||||
Decode(&cfg)
|
|
||||||
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.Equal(t, []string{"key1", "key2", "key3"}, cfg.Section.Keys)
|
|
||||||
assert.Equal(t, "value1", cfg.Section.Values["key1"])
|
|
||||||
assert.Equal(t, "value2", cfg.Section.Values["key2"])
|
|
||||||
assert.Equal(t, "value3", cfg.Section.Values["key3"])
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIssue873_TableUnmarshaler_EmptyTable(t *testing.T) {
|
|
||||||
type Config struct {
|
|
||||||
Section customTable873 `toml:"section"`
|
|
||||||
}
|
|
||||||
|
|
||||||
doc := `
|
|
||||||
[section]
|
|
||||||
`
|
|
||||||
|
|
||||||
var cfg Config
|
|
||||||
err := toml.NewDecoder(bytes.NewReader([]byte(doc))).
|
|
||||||
EnableUnmarshalerInterface().
|
|
||||||
Decode(&cfg)
|
|
||||||
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.Equal(t, []string{}, cfg.Section.Keys)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIssue873_ArrayTableUnmarshaler(t *testing.T) {
|
|
||||||
type Config struct {
|
|
||||||
Items []customTable873 `toml:"items"`
|
|
||||||
}
|
|
||||||
|
|
||||||
doc := `
|
|
||||||
[[items]]
|
|
||||||
name = "first"
|
|
||||||
id = "1"
|
|
||||||
|
|
||||||
[[items]]
|
|
||||||
name = "second"
|
|
||||||
id = "2"
|
|
||||||
`
|
|
||||||
|
|
||||||
var cfg Config
|
|
||||||
err := toml.NewDecoder(bytes.NewReader([]byte(doc))).
|
|
||||||
EnableUnmarshalerInterface().
|
|
||||||
Decode(&cfg)
|
|
||||||
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.Equal(t, 2, len(cfg.Items))
|
|
||||||
assert.Equal(t, []string{"name", "id"}, cfg.Items[0].Keys)
|
|
||||||
assert.Equal(t, "first", cfg.Items[0].Values["name"])
|
|
||||||
assert.Equal(t, "1", cfg.Items[0].Values["id"])
|
|
||||||
assert.Equal(t, []string{"name", "id"}, cfg.Items[1].Keys)
|
|
||||||
assert.Equal(t, "second", cfg.Items[1].Values["name"])
|
|
||||||
assert.Equal(t, "2", cfg.Items[1].Values["id"])
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIssue873_NestedTableUnmarshaler(t *testing.T) {
|
|
||||||
type Config struct {
|
|
||||||
Outer struct {
|
|
||||||
Inner customTable873 `toml:"inner"`
|
|
||||||
} `toml:"outer"`
|
|
||||||
}
|
|
||||||
|
|
||||||
doc := `
|
|
||||||
[outer.inner]
|
|
||||||
a = "A"
|
|
||||||
b = "B"
|
|
||||||
`
|
|
||||||
|
|
||||||
var cfg Config
|
|
||||||
err := toml.NewDecoder(bytes.NewReader([]byte(doc))).
|
|
||||||
EnableUnmarshalerInterface().
|
|
||||||
Decode(&cfg)
|
|
||||||
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.Equal(t, []string{"a", "b"}, cfg.Outer.Inner.Keys)
|
|
||||||
assert.Equal(t, "A", cfg.Outer.Inner.Values["a"])
|
|
||||||
assert.Equal(t, "B", cfg.Outer.Inner.Values["b"])
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIssue873_TableUnmarshaler_MultipleTables(t *testing.T) {
|
|
||||||
type Config struct {
|
|
||||||
First customTable873 `toml:"first"`
|
|
||||||
Second customTable873 `toml:"second"`
|
|
||||||
}
|
|
||||||
|
|
||||||
doc := `
|
|
||||||
[first]
|
|
||||||
key1 = "value1"
|
|
||||||
|
|
||||||
[second]
|
|
||||||
key2 = "value2"
|
|
||||||
`
|
|
||||||
|
|
||||||
var cfg Config
|
|
||||||
err := toml.NewDecoder(bytes.NewReader([]byte(doc))).
|
|
||||||
EnableUnmarshalerInterface().
|
|
||||||
Decode(&cfg)
|
|
||||||
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.Equal(t, []string{"key1"}, cfg.First.Keys)
|
|
||||||
assert.Equal(t, "value1", cfg.First.Values["key1"])
|
|
||||||
assert.Equal(t, []string{"key2"}, cfg.Second.Keys)
|
|
||||||
assert.Equal(t, "value2", cfg.Second.Values["key2"])
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test that regular struct fields still work alongside Unmarshaler tables
|
|
||||||
func TestIssue873_MixedWithRegularFields(t *testing.T) {
|
|
||||||
type Config struct {
|
|
||||||
Name string `toml:"name"`
|
|
||||||
Section customTable873 `toml:"section"`
|
|
||||||
Count int `toml:"count"`
|
|
||||||
}
|
|
||||||
|
|
||||||
doc := `
|
|
||||||
name = "test"
|
|
||||||
count = 42
|
|
||||||
|
|
||||||
[section]
|
|
||||||
foo = "bar"
|
|
||||||
`
|
|
||||||
|
|
||||||
var cfg Config
|
|
||||||
err := toml.NewDecoder(bytes.NewReader([]byte(doc))).
|
|
||||||
EnableUnmarshalerInterface().
|
|
||||||
Decode(&cfg)
|
|
||||||
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.Equal(t, "test", cfg.Name)
|
|
||||||
assert.Equal(t, 42, cfg.Count)
|
|
||||||
assert.Equal(t, []string{"foo"}, cfg.Section.Keys)
|
|
||||||
assert.Equal(t, "bar", cfg.Section.Values["foo"])
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test that pointer to Unmarshaler type works
|
|
||||||
func TestIssue873_PointerToUnmarshaler(t *testing.T) {
|
|
||||||
type Config struct {
|
|
||||||
Section *customTable873 `toml:"section"`
|
|
||||||
}
|
|
||||||
|
|
||||||
doc := `
|
|
||||||
[section]
|
|
||||||
hello = "world"
|
|
||||||
`
|
|
||||||
|
|
||||||
var cfg Config
|
|
||||||
err := toml.NewDecoder(bytes.NewReader([]byte(doc))).
|
|
||||||
EnableUnmarshalerInterface().
|
|
||||||
Decode(&cfg)
|
|
||||||
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.True(t, cfg.Section != nil)
|
|
||||||
assert.Equal(t, []string{"hello"}, cfg.Section.Keys)
|
|
||||||
assert.Equal(t, "world", cfg.Section.Values["hello"])
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test table with sub-tables defined separately
|
|
||||||
func TestIssue873_TableWithSubTables(t *testing.T) {
|
|
||||||
type Config struct {
|
|
||||||
Parent customTable873 `toml:"parent"`
|
|
||||||
}
|
|
||||||
|
|
||||||
doc := `
|
|
||||||
[parent]
|
|
||||||
name = "root"
|
|
||||||
|
|
||||||
[parent.child]
|
|
||||||
name = "nested"
|
|
||||||
`
|
|
||||||
|
|
||||||
var cfg Config
|
|
||||||
err := toml.NewDecoder(bytes.NewReader([]byte(doc))).
|
|
||||||
EnableUnmarshalerInterface().
|
|
||||||
Decode(&cfg)
|
|
||||||
|
|
||||||
// The parent should only get the keys directly under [parent],
|
|
||||||
// not the [parent.child] sub-table
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.Equal(t, []string{"name"}, cfg.Parent.Keys)
|
|
||||||
assert.Equal(t, "root", cfg.Parent.Values["name"])
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test for issue #994 follow-up - tables defined piece-wise
|
|
||||||
// This addresses the maintainer's comment: "It doesn't deal with tables defined piece-wise yet"
|
|
||||||
func TestIssue994_TablesPieceWise(t *testing.T) {
|
|
||||||
// Test with piece-wise table definition (using [table] syntax)
|
|
||||||
// The customTable873 type captures key-value pairs in order,
|
|
||||||
// which is useful for use cases like maintaining map ordering
|
|
||||||
doc := `
|
|
||||||
[section]
|
|
||||||
first = "1"
|
|
||||||
second = "2"
|
|
||||||
third = "3"
|
|
||||||
`
|
|
||||||
|
|
||||||
type Config struct {
|
|
||||||
Section customTable873 `toml:"section"`
|
|
||||||
}
|
|
||||||
|
|
||||||
var cfg Config
|
|
||||||
err := toml.NewDecoder(bytes.NewReader([]byte(doc))).
|
|
||||||
EnableUnmarshalerInterface().
|
|
||||||
Decode(&cfg)
|
|
||||||
|
|
||||||
assert.NoError(t, err)
|
|
||||||
// Verify ordering is preserved (keys are collected in document order)
|
|
||||||
assert.Equal(t, []string{"first", "second", "third"}, cfg.Section.Keys)
|
|
||||||
assert.Equal(t, "1", cfg.Section.Values["first"])
|
|
||||||
assert.Equal(t, "2", cfg.Section.Values["second"])
|
|
||||||
assert.Equal(t, "3", cfg.Section.Values["third"])
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test root-level struct with tables - combines #994 fix with #873 enhancement
|
|
||||||
func TestIssue994_RootWithTables(t *testing.T) {
|
|
||||||
type rootDoc struct {
|
|
||||||
Tables []customTable873 `toml:"tables"`
|
|
||||||
}
|
|
||||||
|
|
||||||
doc := `
|
|
||||||
[[tables]]
|
|
||||||
name = "first"
|
|
||||||
value = "one"
|
|
||||||
|
|
||||||
[[tables]]
|
|
||||||
name = "second"
|
|
||||||
value = "two"
|
|
||||||
`
|
|
||||||
|
|
||||||
var d rootDoc
|
|
||||||
err := toml.NewDecoder(bytes.NewReader([]byte(doc))).
|
|
||||||
EnableUnmarshalerInterface().
|
|
||||||
Decode(&d)
|
|
||||||
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.Equal(t, 2, len(d.Tables))
|
|
||||||
assert.Equal(t, "first", d.Tables[0].Values["name"])
|
|
||||||
assert.Equal(t, "one", d.Tables[0].Values["value"])
|
|
||||||
assert.Equal(t, "second", d.Tables[1].Values["name"])
|
|
||||||
assert.Equal(t, "two", d.Tables[1].Values["value"])
|
|
||||||
}
|
|
||||||
|
|
||||||
// Test for split tables - when the same parent table is defined in multiple places
|
// Test for split tables - when the same parent table is defined in multiple places
|
||||||
// This is a key requirement for issue #873: if type A implements Unmarshaler,
|
// This is a key requirement for issue #873: if type A implements Unmarshaler,
|
||||||
// and [a.b] and [a.d] are defined with another table [x] in between,
|
// and [a.b] and [a.d] are defined with another table [x] in between,
|
||||||
|
|||||||
+1
-1
@@ -345,7 +345,7 @@ func (p *Parser) parseKeyval(b []byte) (reference, []byte, error) {
|
|||||||
b = p.parseWhitespace(b)
|
b = p.parseWhitespace(b)
|
||||||
|
|
||||||
if len(b) == 0 {
|
if len(b) == 0 {
|
||||||
return invalidReference, nil, NewParserError(b, "expected = after a key, but the document ends there")
|
return invalidReference, nil, NewParserError(startB[:len(startB)-len(b)], "expected = after a key, but the document ends there")
|
||||||
}
|
}
|
||||||
|
|
||||||
b, err = expect('=', b)
|
b, err = expect('=', b)
|
||||||
|
|||||||
Reference in New Issue
Block a user