Compare commits
23 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 068279f13b | |||
| b9edbeb611 | |||
| a97c9317d4 | |||
| 3229a0abfb | |||
| 3f5d8a6b06 | |||
| 146f70ea8a | |||
| e83cf535f5 | |||
| c3ba3ef97a | |||
| 7ee3c8ff25 | |||
| 1e85aa6d78 | |||
| 46fa3225e2 | |||
| 4d51831dab | |||
| 5a1a96cb2d | |||
| ea9040ae83 | |||
| 2373685f1e | |||
| f1391952d4 | |||
| 4a73a200ed | |||
| 4807229e94 | |||
| d8ddc00c61 | |||
| 82f8dad811 | |||
| 75db1016e8 | |||
| de6d715bd2 | |||
| 3ab2fc2b87 |
@@ -15,6 +15,6 @@ jobs:
|
|||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@master
|
uses: actions/setup-go@master
|
||||||
with:
|
with:
|
||||||
go-version: 1.16
|
go-version: 1.18
|
||||||
- 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}"
|
||||||
|
|||||||
@@ -0,0 +1,39 @@
|
|||||||
|
name: release
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "v2.*"
|
||||||
|
workflow_call:
|
||||||
|
inputs:
|
||||||
|
args:
|
||||||
|
description: "Extra arguments to pass goreleaser"
|
||||||
|
default: ""
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- name: Set up Go
|
||||||
|
uses: actions/setup-go@v2
|
||||||
|
with:
|
||||||
|
go-version: 1.18
|
||||||
|
- name: Login to GitHub Container Registry
|
||||||
|
uses: docker/login-action@v1
|
||||||
|
with:
|
||||||
|
registry: ghcr.io
|
||||||
|
username: ${{ github.actor }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
- name: Run GoReleaser
|
||||||
|
uses: goreleaser/goreleaser-action@v2
|
||||||
|
with:
|
||||||
|
distribution: goreleaser
|
||||||
|
version: latest
|
||||||
|
args: release ${{ inputs.args }} --rm-dist
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
@@ -12,14 +12,21 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [ 'ubuntu-latest', 'windows-latest', 'macos-latest']
|
os: [ 'ubuntu-latest', 'windows-latest', 'macos-latest']
|
||||||
go: [ '1.16', '1.17' ]
|
go: [ '1.17', '1.18' ]
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
name: ${{ matrix.go }}/${{ matrix.os }}
|
name: ${{ matrix.go }}/${{ matrix.os }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@master
|
- uses: actions/checkout@master
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
- name: Setup go ${{ matrix.go }}
|
- name: Setup go ${{ matrix.go }}
|
||||||
uses: actions/setup-go@master
|
uses: actions/setup-go@master
|
||||||
with:
|
with:
|
||||||
go-version: ${{ matrix.go }}
|
go-version: ${{ matrix.go }}
|
||||||
- name: Run unit tests
|
- name: Run unit tests
|
||||||
run: go test -race ./...
|
run: go test -race ./...
|
||||||
|
release-check:
|
||||||
|
if: ${{ github.ref != 'refs/heads/v2' }}
|
||||||
|
uses: pelletier/go-toml/.github/workflows/release.yml@v2
|
||||||
|
with:
|
||||||
|
args: --snapshot
|
||||||
|
|||||||
@@ -3,3 +3,4 @@ fuzz/
|
|||||||
cmd/tomll/tomll
|
cmd/tomll/tomll
|
||||||
cmd/tomljson/tomljson
|
cmd/tomljson/tomljson
|
||||||
cmd/tomltestgen/tomltestgen
|
cmd/tomltestgen/tomltestgen
|
||||||
|
dist
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
before:
|
||||||
|
hooks:
|
||||||
|
- go mod tidy
|
||||||
|
- go fmt ./...
|
||||||
|
- go test ./...
|
||||||
|
builds:
|
||||||
|
- id: tomll
|
||||||
|
main: ./cmd/tomll
|
||||||
|
binary: tomll
|
||||||
|
env:
|
||||||
|
- CGO_ENABLED=0
|
||||||
|
flags:
|
||||||
|
- -trimpath
|
||||||
|
ldflags:
|
||||||
|
- -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.CommitDate}}
|
||||||
|
mod_timestamp: '{{ .CommitTimestamp }}'
|
||||||
|
targets:
|
||||||
|
- linux_amd64
|
||||||
|
- windows_amd64
|
||||||
|
- darwin_amd64
|
||||||
|
- darwin_arm64
|
||||||
|
- id: tomljson
|
||||||
|
main: ./cmd/tomljson
|
||||||
|
binary: tomljson
|
||||||
|
env:
|
||||||
|
- CGO_ENABLED=0
|
||||||
|
flags:
|
||||||
|
- -trimpath
|
||||||
|
ldflags:
|
||||||
|
- -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.CommitDate}}
|
||||||
|
mod_timestamp: '{{ .CommitTimestamp }}'
|
||||||
|
targets:
|
||||||
|
- linux_amd64
|
||||||
|
- windows_amd64
|
||||||
|
- darwin_amd64
|
||||||
|
- darwin_arm64
|
||||||
|
- id: jsontoml
|
||||||
|
main: ./cmd/jsontoml
|
||||||
|
binary: jsontoml
|
||||||
|
env:
|
||||||
|
- CGO_ENABLED=0
|
||||||
|
flags:
|
||||||
|
- -trimpath
|
||||||
|
ldflags:
|
||||||
|
- -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.CommitDate}}
|
||||||
|
mod_timestamp: '{{ .CommitTimestamp }}'
|
||||||
|
targets:
|
||||||
|
- linux_amd64
|
||||||
|
- windows_amd64
|
||||||
|
- darwin_amd64
|
||||||
|
- darwin_arm64
|
||||||
|
universal_binaries:
|
||||||
|
- id: tomll
|
||||||
|
replace: true
|
||||||
|
name_template: tomll
|
||||||
|
- id: tomljson
|
||||||
|
replace: true
|
||||||
|
name_template: tomljson
|
||||||
|
- id: jsontoml
|
||||||
|
replace: true
|
||||||
|
name_template: jsontoml
|
||||||
|
archives:
|
||||||
|
- id: jsontoml
|
||||||
|
format: tar.xz
|
||||||
|
builds:
|
||||||
|
- jsontoml
|
||||||
|
files:
|
||||||
|
- none*
|
||||||
|
name_template: "{{ .Binary }}_{{.Version}}_{{ .Os }}_{{ .Arch }}"
|
||||||
|
- id: tomljson
|
||||||
|
format: tar.xz
|
||||||
|
builds:
|
||||||
|
- tomljson
|
||||||
|
files:
|
||||||
|
- none*
|
||||||
|
name_template: "{{ .Binary }}_{{.Version}}_{{ .Os }}_{{ .Arch }}"
|
||||||
|
- id: tomll
|
||||||
|
format: tar.xz
|
||||||
|
builds:
|
||||||
|
- tomll
|
||||||
|
files:
|
||||||
|
- none*
|
||||||
|
name_template: "{{ .Binary }}_{{.Version}}_{{ .Os }}_{{ .Arch }}"
|
||||||
|
dockers:
|
||||||
|
- id: tools
|
||||||
|
goos: linux
|
||||||
|
goarch: amd64
|
||||||
|
ids:
|
||||||
|
- jsontoml
|
||||||
|
- tomljson
|
||||||
|
- tomll
|
||||||
|
image_templates:
|
||||||
|
- "ghcr.io/pelletier/go-toml:latest"
|
||||||
|
- "ghcr.io/pelletier/go-toml:{{ .Tag }}"
|
||||||
|
- "ghcr.io/pelletier/go-toml:v{{ .Major }}"
|
||||||
|
skip_push: false
|
||||||
|
checksum:
|
||||||
|
name_template: 'sha256sums.txt'
|
||||||
|
snapshot:
|
||||||
|
name_template: "{{ incpatch .Version }}-next"
|
||||||
|
release:
|
||||||
|
github:
|
||||||
|
owner: pelletier
|
||||||
|
name: go-toml
|
||||||
|
draft: true
|
||||||
|
prerelease: auto
|
||||||
|
mode: replace
|
||||||
|
changelog:
|
||||||
|
use: github-native
|
||||||
|
announce:
|
||||||
|
skip: true
|
||||||
+23
-9
@@ -155,6 +155,8 @@ Checklist:
|
|||||||
- Does not introduce backward-incompatible changes (unless discussed).
|
- Does not introduce backward-incompatible changes (unless discussed).
|
||||||
- Has relevant doc changes.
|
- Has relevant doc changes.
|
||||||
- Benchstat does not show performance regression.
|
- Benchstat does not show performance regression.
|
||||||
|
- Pull request is [labeled appropriately][pr-labels].
|
||||||
|
- Title will be understandable in the changelog.
|
||||||
|
|
||||||
1. Merge using "squash and merge".
|
1. Merge using "squash and merge".
|
||||||
2. Make sure to edit the commit message to keep all the useful information
|
2. Make sure to edit the commit message to keep all the useful information
|
||||||
@@ -163,13 +165,25 @@ Checklist:
|
|||||||
|
|
||||||
### New release
|
### New release
|
||||||
|
|
||||||
1. Go to [releases][releases]. Click on "X commits to master since this
|
1. Decide on the next version number. Use semver.
|
||||||
release".
|
2. Generate release notes using [`gh`][gh]. Example:
|
||||||
2. Make note of all the changes. Look for backward incompatible changes,
|
```
|
||||||
new features, and bug fixes.
|
$ gh api -X POST \
|
||||||
3. Pick the new version using the above and semver.
|
-F tag_name='v2.0.0-beta.5' \
|
||||||
4. Create a [new release][new-release].
|
-F target_commitish='v2' \
|
||||||
5. Follow the same format as [1.1.0][release-110].
|
-F previous_tag_name='v2.0.0-beta.4' \
|
||||||
|
--jq '.body' \
|
||||||
|
repos/pelletier/go-toml/releases/generate-notes
|
||||||
|
```
|
||||||
|
3. Look for "Other changes". That would indicate a pull request not labeled
|
||||||
|
properly. Tweak labels and pull request titles until changelog looks good for
|
||||||
|
users.
|
||||||
|
4. [Draft new release][new-release].
|
||||||
|
5. Fill tag and target with the same value used to generate the changelog.
|
||||||
|
6. Set title to the new tag value.
|
||||||
|
7. Paste the generated changelog.
|
||||||
|
8. Check "create discussion", in the "Releases" category.
|
||||||
|
9. Check pre-release if new version is an alpha or beta.
|
||||||
|
|
||||||
[issues-tracker]: https://github.com/pelletier/go-toml/issues
|
[issues-tracker]: https://github.com/pelletier/go-toml/issues
|
||||||
[bug-report]: https://github.com/pelletier/go-toml/issues/new?template=bug_report.md
|
[bug-report]: https://github.com/pelletier/go-toml/issues/new?template=bug_report.md
|
||||||
@@ -177,6 +191,6 @@ Checklist:
|
|||||||
[readme]: ./README.md
|
[readme]: ./README.md
|
||||||
[fork]: https://help.github.com/articles/fork-a-repo
|
[fork]: https://help.github.com/articles/fork-a-repo
|
||||||
[pull-request]: https://help.github.com/en/articles/creating-a-pull-request
|
[pull-request]: https://help.github.com/en/articles/creating-a-pull-request
|
||||||
[releases]: https://github.com/pelletier/go-toml/releases
|
|
||||||
[new-release]: https://github.com/pelletier/go-toml/releases/new
|
[new-release]: https://github.com/pelletier/go-toml/releases/new
|
||||||
[release-110]: https://github.com/pelletier/go-toml/releases/tag/v1.1.0
|
[gh]: https://github.com/cli/cli
|
||||||
|
[pr-labels]: https://github.com/pelletier/go-toml/blob/v2/.github/release.yml
|
||||||
|
|||||||
@@ -0,0 +1,5 @@
|
|||||||
|
FROM scratch
|
||||||
|
ENV PATH "$PATH:/bin"
|
||||||
|
COPY tomll /bin/tomll
|
||||||
|
COPY tomljson /bin/tomljson
|
||||||
|
COPY jsontoml /bin/jsontoml
|
||||||
@@ -21,7 +21,8 @@ encouraged to try out this version.
|
|||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Full API, examples, and implementation notes are available in the Go documentation.
|
Full API, examples, and implementation notes are available in the Go
|
||||||
|
documentation.
|
||||||
|
|
||||||
[](https://pkg.go.dev/github.com/pelletier/go-toml/v2)
|
[](https://pkg.go.dev/github.com/pelletier/go-toml/v2)
|
||||||
|
|
||||||
@@ -51,7 +52,7 @@ operations should not be shockingly slow. See [benchmarks](#benchmarks).
|
|||||||
the TOML document was not prevent in the target structure. This is a great way
|
the TOML document was not prevent in the target structure. This is a great way
|
||||||
to check for typos. [See example in the documentation][strict].
|
to check for typos. [See example in the documentation][strict].
|
||||||
|
|
||||||
[strict]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#example-Decoder.SetStrict
|
[strict]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#example-Decoder.DisallowUnknownFields
|
||||||
|
|
||||||
### Contextualized errors
|
### Contextualized errors
|
||||||
|
|
||||||
@@ -207,6 +208,44 @@ In case of trouble: [Go Modules FAQ][mod-faq].
|
|||||||
|
|
||||||
[mod-faq]: https://github.com/golang/go/wiki/Modules#why-does-installing-a-tool-via-go-get-fail-with-error-cannot-find-main-module
|
[mod-faq]: https://github.com/golang/go/wiki/Modules#why-does-installing-a-tool-via-go-get-fail-with-error-cannot-find-main-module
|
||||||
|
|
||||||
|
## Tools
|
||||||
|
|
||||||
|
Go-toml provides three handy command line tools:
|
||||||
|
|
||||||
|
* `tomljson`: Reads a TOML file and outputs its JSON representation.
|
||||||
|
|
||||||
|
```
|
||||||
|
$ go install github.com/pelletier/go-toml/v2/cmd/tomljson@latest
|
||||||
|
$ tomljson --help
|
||||||
|
```
|
||||||
|
|
||||||
|
* `jsontoml`: Reads a JSON file and outputs a TOML representation.
|
||||||
|
|
||||||
|
```
|
||||||
|
$ go install github.com/pelletier/go-toml/v2/cmd/jsontoml@latest
|
||||||
|
$ jsontoml --help
|
||||||
|
```
|
||||||
|
|
||||||
|
* `tomll`: Lints and reformats a TOML file.
|
||||||
|
|
||||||
|
```
|
||||||
|
$ go install github.com/pelletier/go-toml/v2/cmd/tomll@latest
|
||||||
|
$ tomll --help
|
||||||
|
```
|
||||||
|
|
||||||
|
### Docker image
|
||||||
|
|
||||||
|
Those tools are also available as a [Docker image][docker]. For example, to use
|
||||||
|
`tomljson`:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker run -i ghcr.io/pelletier/go-toml:v2 tomljson < example.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
Multiple versions are availble on [ghcr.io][docker].
|
||||||
|
|
||||||
|
[docker]: https://github.com/pelletier/go-toml/pkgs/container/go-toml
|
||||||
|
|
||||||
## Migrating from v1
|
## Migrating from v1
|
||||||
|
|
||||||
This section describes the differences between v1 and v2, with some pointers on
|
This section describes the differences between v1 and v2, with some pointers on
|
||||||
@@ -488,45 +527,30 @@ The new name is `Encoder.SetArraysMultiline`. The behavior should be the same.
|
|||||||
The new name is `Encoder.SetIndentSymbol`. The behavior should be the same.
|
The new name is `Encoder.SetIndentSymbol`. The behavior should be the same.
|
||||||
|
|
||||||
|
|
||||||
#### Embedded structs are tables
|
#### Embedded structs behave like stdlib
|
||||||
|
|
||||||
V1 defaults to merging embedded struct fields into the embedding struct. This
|
V1 defaults to merging embedded struct fields into the embedding struct. This
|
||||||
behavior was unexpected because it does not follow the standard library. To
|
behavior was unexpected because it does not follow the standard library. To
|
||||||
avoid breaking backward compatibility, the `Encoder.PromoteAnonymous` method was
|
avoid breaking backward compatibility, the `Encoder.PromoteAnonymous` method was
|
||||||
added to make the encoder behave correctly. Given backward compatibility is not
|
added to make the encoder behave correctly. Given backward compatibility is not
|
||||||
a problem anymore, v2 does the right thing by default. There is no way to revert
|
a problem anymore, v2 does the right thing by default: it follows the behavior
|
||||||
to the old behavior, and `Encoder.PromoteAnonymous` has been removed.
|
of `encoding/json`. `Encoder.PromoteAnonymous` has been removed.
|
||||||
|
|
||||||
```go
|
|
||||||
type Embedded struct {
|
|
||||||
Value string `toml:"value"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type Doc struct {
|
|
||||||
Embedded
|
|
||||||
}
|
|
||||||
|
|
||||||
d := Doc{}
|
|
||||||
|
|
||||||
fmt.Println("v1:")
|
|
||||||
b, err := v1.Marshal(d)
|
|
||||||
fmt.Println(string(b))
|
|
||||||
|
|
||||||
fmt.Println("v2:")
|
|
||||||
b, err = v2.Marshal(d)
|
|
||||||
fmt.Println(string(b))
|
|
||||||
|
|
||||||
// Output:
|
|
||||||
// v1:
|
|
||||||
// value = ""
|
|
||||||
//
|
|
||||||
// v2:
|
|
||||||
// [Embedded]
|
|
||||||
// value = ''
|
|
||||||
```
|
|
||||||
|
|
||||||
[nodoc]: https://github.com/pelletier/go-toml/discussions/506#discussioncomment-1526038
|
[nodoc]: https://github.com/pelletier/go-toml/discussions/506#discussioncomment-1526038
|
||||||
|
|
||||||
|
### `query`
|
||||||
|
|
||||||
|
go-toml v1 provided the [`go-toml/query`][query] package. It allowed to run
|
||||||
|
JSONPath-style queries on TOML files. This feature is not available in v2. For a
|
||||||
|
replacement, check out [dasel][dasel].
|
||||||
|
|
||||||
|
This package has been removed because it was essentially not supported anymore
|
||||||
|
(last commit May 2020), increased the complexity of the code base, and more
|
||||||
|
complete solutions exist out there.
|
||||||
|
|
||||||
|
[query]: https://github.com/pelletier/go-toml/tree/f99d6bbca119636aeafcf351ee52b3d202782627/query
|
||||||
|
[dasel]: https://github.com/TomWright/dasel
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
The MIT License (MIT). Read [LICENSE](LICENSE).
|
The MIT License (MIT). Read [LICENSE](LICENSE).
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
|
|
||||||
"github.com/pelletier/go-toml/v2/testsuite"
|
"github.com/pelletier/go-toml/v2/internal/testsuite"
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
|||||||
@@ -0,0 +1,55 @@
|
|||||||
|
// Package jsontoml is a program that converts JSON to TOML.
|
||||||
|
//
|
||||||
|
// Usage
|
||||||
|
//
|
||||||
|
// Reading from stdin:
|
||||||
|
//
|
||||||
|
// cat file.json | jsontoml > file.toml
|
||||||
|
//
|
||||||
|
// Reading from a file:
|
||||||
|
//
|
||||||
|
// jsontoml file.json > file.toml
|
||||||
|
//
|
||||||
|
// Installation
|
||||||
|
//
|
||||||
|
// Using Go:
|
||||||
|
//
|
||||||
|
// go install github.com/pelletier/go-toml/v2/cmd/jsontoml@latest
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"github.com/pelletier/go-toml/v2"
|
||||||
|
"github.com/pelletier/go-toml/v2/internal/cli"
|
||||||
|
)
|
||||||
|
|
||||||
|
const usage = `jsontoml can be used in two ways:
|
||||||
|
Reading from stdin:
|
||||||
|
cat file.json | jsontoml > file.toml
|
||||||
|
|
||||||
|
Reading from a file:
|
||||||
|
jsontoml file.json > file.toml
|
||||||
|
`
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
p := cli.Program{
|
||||||
|
Usage: usage,
|
||||||
|
Fn: convert,
|
||||||
|
}
|
||||||
|
p.Execute()
|
||||||
|
}
|
||||||
|
|
||||||
|
func convert(r io.Reader, w io.Writer) error {
|
||||||
|
var v interface{}
|
||||||
|
|
||||||
|
d := json.NewDecoder(r)
|
||||||
|
err := d.Decode(&v)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
e := toml.NewEncoder(w)
|
||||||
|
return e.Encode(v)
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestConvert(t *testing.T) {
|
||||||
|
examples := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
expected string
|
||||||
|
errors bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid json",
|
||||||
|
input: `
|
||||||
|
{
|
||||||
|
"mytoml": {
|
||||||
|
"a": 42
|
||||||
|
}
|
||||||
|
}`,
|
||||||
|
expected: `[mytoml]
|
||||||
|
a = 42.0
|
||||||
|
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid json",
|
||||||
|
input: `{ foo`,
|
||||||
|
errors: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, e := range examples {
|
||||||
|
b := new(bytes.Buffer)
|
||||||
|
err := convert(strings.NewReader(e.input), b)
|
||||||
|
if e.errors {
|
||||||
|
require.Error(t, err)
|
||||||
|
} else {
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equal(t, e.expected, b.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
// Package tomljson is a program that converts TOML to JSON.
|
||||||
|
//
|
||||||
|
// Usage
|
||||||
|
//
|
||||||
|
// Reading from stdin:
|
||||||
|
//
|
||||||
|
// cat file.toml | tomljson > file.json
|
||||||
|
//
|
||||||
|
// Reading from a file:
|
||||||
|
//
|
||||||
|
// tomljson file.toml > file.json
|
||||||
|
//
|
||||||
|
// Installation
|
||||||
|
//
|
||||||
|
// Using Go:
|
||||||
|
//
|
||||||
|
// go install github.com/pelletier/go-toml/v2/cmd/tomljson@latest
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"github.com/pelletier/go-toml/v2"
|
||||||
|
"github.com/pelletier/go-toml/v2/internal/cli"
|
||||||
|
)
|
||||||
|
|
||||||
|
const usage = `tomljson can be used in two ways:
|
||||||
|
Reading from stdin:
|
||||||
|
cat file.toml | tomljson > file.json
|
||||||
|
|
||||||
|
Reading from a file:
|
||||||
|
tomljson file.toml > file.json
|
||||||
|
`
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
p := cli.Program{
|
||||||
|
Usage: usage,
|
||||||
|
Fn: convert,
|
||||||
|
}
|
||||||
|
p.Execute()
|
||||||
|
}
|
||||||
|
|
||||||
|
func convert(r io.Reader, w io.Writer) error {
|
||||||
|
var v interface{}
|
||||||
|
|
||||||
|
d := toml.NewDecoder(r)
|
||||||
|
err := d.Decode(&v)
|
||||||
|
if err != nil {
|
||||||
|
var derr *toml.DecodeError
|
||||||
|
if errors.As(err, &derr) {
|
||||||
|
row, col := derr.Position()
|
||||||
|
return fmt.Errorf("%s\nerror occurred at row %d column %d", derr.String(), row, col)
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
e := json.NewEncoder(w)
|
||||||
|
e.SetIndent("", " ")
|
||||||
|
return e.Encode(v)
|
||||||
|
}
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestConvert(t *testing.T) {
|
||||||
|
examples := []struct {
|
||||||
|
name string
|
||||||
|
input io.Reader
|
||||||
|
expected string
|
||||||
|
errors bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid toml",
|
||||||
|
input: strings.NewReader(`
|
||||||
|
[mytoml]
|
||||||
|
a = 42`),
|
||||||
|
expected: `{
|
||||||
|
"mytoml": {
|
||||||
|
"a": 42
|
||||||
|
}
|
||||||
|
}
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid toml",
|
||||||
|
input: strings.NewReader(`bad = []]`),
|
||||||
|
errors: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "bad reader",
|
||||||
|
input: &badReader{},
|
||||||
|
errors: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, e := range examples {
|
||||||
|
b := new(bytes.Buffer)
|
||||||
|
err := convert(e.input, b)
|
||||||
|
if e.errors {
|
||||||
|
require.Error(t, err)
|
||||||
|
} else {
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equal(t, e.expected, b.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type badReader struct{}
|
||||||
|
|
||||||
|
func (r *badReader) Read([]byte) (int, error) {
|
||||||
|
return 0, fmt.Errorf("reader failed on purpose")
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
// Package tomll is a linter program for TOML.
|
||||||
|
//
|
||||||
|
// Usage
|
||||||
|
//
|
||||||
|
// Reading from stdin, writing to stdout:
|
||||||
|
//
|
||||||
|
// cat file.toml | tomll
|
||||||
|
//
|
||||||
|
// Reading and updating a list of files in place:
|
||||||
|
//
|
||||||
|
// tomll a.toml b.toml c.toml
|
||||||
|
//
|
||||||
|
// Installation
|
||||||
|
//
|
||||||
|
// Using Go:
|
||||||
|
//
|
||||||
|
// go install github.com/pelletier/go-toml/v2/cmd/tomll@latest
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"github.com/pelletier/go-toml/v2"
|
||||||
|
"github.com/pelletier/go-toml/v2/internal/cli"
|
||||||
|
)
|
||||||
|
|
||||||
|
const usage = `tomll can be used in two ways:
|
||||||
|
|
||||||
|
Reading from stdin, writing to stdout:
|
||||||
|
cat file.toml | tomll > file.toml
|
||||||
|
|
||||||
|
Reading and updating a list of files in place:
|
||||||
|
tomll a.toml b.toml c.toml
|
||||||
|
|
||||||
|
When given a list of files, tomll will modify all files in place without asking.
|
||||||
|
`
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
p := cli.Program{
|
||||||
|
Usage: usage,
|
||||||
|
Fn: convert,
|
||||||
|
Inplace: true,
|
||||||
|
}
|
||||||
|
p.Execute()
|
||||||
|
}
|
||||||
|
|
||||||
|
func convert(r io.Reader, w io.Writer) error {
|
||||||
|
var v interface{}
|
||||||
|
|
||||||
|
d := toml.NewDecoder(r)
|
||||||
|
err := d.Decode(&v)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
e := toml.NewEncoder(w)
|
||||||
|
return e.Encode(v)
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestConvert(t *testing.T) {
|
||||||
|
examples := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
expected string
|
||||||
|
errors bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid toml",
|
||||||
|
input: `
|
||||||
|
mytoml.a = 42.0
|
||||||
|
`,
|
||||||
|
expected: `[mytoml]
|
||||||
|
a = 42.0
|
||||||
|
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid toml",
|
||||||
|
input: `[what`,
|
||||||
|
errors: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, e := range examples {
|
||||||
|
b := new(bytes.Buffer)
|
||||||
|
err := convert(strings.NewReader(e.input), b)
|
||||||
|
if e.errors {
|
||||||
|
require.Error(t, err)
|
||||||
|
} else {
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equal(t, e.expected, b.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -309,10 +309,10 @@ func parseFloat(b []byte) (float64, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
start := 0
|
start := 0
|
||||||
if b[0] == '+' || b[0] == '-' {
|
if cleaned[0] == '+' || cleaned[0] == '-' {
|
||||||
start = 1
|
start = 1
|
||||||
}
|
}
|
||||||
if b[start] == '0' && isDigit(b[start+1]) {
|
if cleaned[start] == '0' && isDigit(cleaned[start+1]) {
|
||||||
return 0, newDecodeError(b, "float integer part cannot have leading zeroes")
|
return 0, newDecodeError(b, "float integer part cannot have leading zeroes")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ type DecodeError struct {
|
|||||||
// corresponding field in the target value. It contains all the missing fields
|
// corresponding field in the target value. It contains all the missing fields
|
||||||
// in Errors.
|
// in Errors.
|
||||||
//
|
//
|
||||||
// Emitted by Decoder when SetStrict(true) was called.
|
// Emitted by Decoder when DisallowUnknownFields() was called.
|
||||||
type StrictMissingError struct {
|
type StrictMissingError struct {
|
||||||
// One error per field that could not be found.
|
// One error per field that could not be found.
|
||||||
Errors []DecodeError
|
Errors []DecodeError
|
||||||
|
|||||||
@@ -2,5 +2,4 @@ module github.com/pelletier/go-toml/v2
|
|||||||
|
|
||||||
go 1.16
|
go 1.16
|
||||||
|
|
||||||
// latest (v1.7.0) doesn't have the fix for time.Time
|
require github.com/stretchr/testify v1.7.1
|
||||||
require github.com/stretchr/testify v1.7.1-0.20210427113832-6241f9ab9942
|
|
||||||
|
|||||||
@@ -3,8 +3,8 @@ github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
|
|||||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
github.com/stretchr/testify v1.7.1-0.20210427113832-6241f9ab9942 h1:t0lM6y/M5IiUZyvbBTcngso8SZEZICH7is9B6g/obVU=
|
github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
|
||||||
github.com/stretchr/testify v1.7.1-0.20210427113832-6241f9ab9942/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
|
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
|
||||||
|
|||||||
@@ -0,0 +1,76 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ConvertFn func(r io.Reader, w io.Writer) error
|
||||||
|
|
||||||
|
type Program struct {
|
||||||
|
Usage string
|
||||||
|
Fn ConvertFn
|
||||||
|
// Inplace allows the command to take more than one file as argument and
|
||||||
|
// perform convertion in place on each provided file.
|
||||||
|
Inplace bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Program) Execute() {
|
||||||
|
flag.Usage = func() { fmt.Fprintf(os.Stderr, p.Usage) }
|
||||||
|
flag.Parse()
|
||||||
|
os.Exit(p.main(flag.Args(), os.Stdin, os.Stdout, os.Stderr))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Program) main(files []string, input io.Reader, output, error io.Writer) int {
|
||||||
|
err := p.run(files, input, output)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintln(error, err.Error())
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Program) run(files []string, input io.Reader, output io.Writer) error {
|
||||||
|
if len(files) > 0 {
|
||||||
|
if p.Inplace {
|
||||||
|
return p.runAllFilesInPlace(files)
|
||||||
|
}
|
||||||
|
f, err := os.Open(files[0])
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer f.Close()
|
||||||
|
input = f
|
||||||
|
}
|
||||||
|
return p.Fn(input, output)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Program) runAllFilesInPlace(files []string) error {
|
||||||
|
for _, path := range files {
|
||||||
|
err := p.runFileInPlace(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Program) runFileInPlace(path string) error {
|
||||||
|
in, err := ioutil.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
out := new(bytes.Buffer)
|
||||||
|
|
||||||
|
err = p.Fn(bytes.NewReader(in), out)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return ioutil.WriteFile(path, out.Bytes(), 0600)
|
||||||
|
}
|
||||||
@@ -0,0 +1,156 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
|
"os"
|
||||||
|
"path"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func processMain(args []string, input io.Reader, stdout, stderr io.Writer, f ConvertFn) int {
|
||||||
|
p := Program{Fn: f}
|
||||||
|
return p.main(args, input, stdout, stderr)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainStdin(t *testing.T) {
|
||||||
|
stdout := new(bytes.Buffer)
|
||||||
|
stderr := new(bytes.Buffer)
|
||||||
|
input := strings.NewReader("this is the input")
|
||||||
|
|
||||||
|
exit := processMain([]string{}, input, stdout, stderr, func(r io.Reader, w io.Writer) error {
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, 0, exit)
|
||||||
|
assert.Empty(t, stdout.String())
|
||||||
|
assert.Empty(t, stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainStdinErr(t *testing.T) {
|
||||||
|
stdout := new(bytes.Buffer)
|
||||||
|
stderr := new(bytes.Buffer)
|
||||||
|
input := strings.NewReader("this is the input")
|
||||||
|
|
||||||
|
exit := processMain([]string{}, input, stdout, stderr, func(r io.Reader, w io.Writer) error {
|
||||||
|
return fmt.Errorf("something bad")
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, -1, exit)
|
||||||
|
assert.Empty(t, stdout.String())
|
||||||
|
assert.NotEmpty(t, stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainFileExists(t *testing.T) {
|
||||||
|
tmpfile, err := ioutil.TempFile("", "example")
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer os.Remove(tmpfile.Name())
|
||||||
|
_, err = tmpfile.Write([]byte(`some data`))
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
stdout := new(bytes.Buffer)
|
||||||
|
stderr := new(bytes.Buffer)
|
||||||
|
|
||||||
|
exit := processMain([]string{tmpfile.Name()}, nil, stdout, stderr, func(r io.Reader, w io.Writer) error {
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, 0, exit)
|
||||||
|
assert.Empty(t, stdout.String())
|
||||||
|
assert.Empty(t, stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainFileDoesNotExist(t *testing.T) {
|
||||||
|
stdout := new(bytes.Buffer)
|
||||||
|
stderr := new(bytes.Buffer)
|
||||||
|
|
||||||
|
exit := processMain([]string{"/lets/hope/this/does/not/exist"}, nil, stdout, stderr, func(r io.Reader, w io.Writer) error {
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, -1, exit)
|
||||||
|
assert.Empty(t, stdout.String())
|
||||||
|
assert.NotEmpty(t, stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainFilesInPlace(t *testing.T) {
|
||||||
|
dir, err := ioutil.TempDir("", "")
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer os.RemoveAll(dir)
|
||||||
|
|
||||||
|
path1 := path.Join(dir, "file1")
|
||||||
|
path2 := path.Join(dir, "file2")
|
||||||
|
|
||||||
|
err = ioutil.WriteFile(path1, []byte("content 1"), 0600)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = ioutil.WriteFile(path2, []byte("content 2"), 0600)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
p := Program{
|
||||||
|
Fn: dummyFileFn,
|
||||||
|
Inplace: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
exit := p.main([]string{path1, path2}, os.Stdin, os.Stdout, os.Stderr)
|
||||||
|
|
||||||
|
require.Equal(t, 0, exit)
|
||||||
|
|
||||||
|
v1, err := ioutil.ReadFile(path1)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, "1", string(v1))
|
||||||
|
|
||||||
|
v2, err := ioutil.ReadFile(path2)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, "2", string(v2))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainFilesInPlaceErrRead(t *testing.T) {
|
||||||
|
p := Program{
|
||||||
|
Fn: dummyFileFn,
|
||||||
|
Inplace: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
exit := p.main([]string{"/this/path/is/invalid"}, os.Stdin, os.Stdout, os.Stderr)
|
||||||
|
|
||||||
|
require.Equal(t, -1, exit)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainFilesInPlaceFailFn(t *testing.T) {
|
||||||
|
dir, err := ioutil.TempDir("", "")
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer os.RemoveAll(dir)
|
||||||
|
|
||||||
|
path1 := path.Join(dir, "file1")
|
||||||
|
|
||||||
|
err = ioutil.WriteFile(path1, []byte("content 1"), 0600)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
p := Program{
|
||||||
|
Fn: func(io.Reader, io.Writer) error { return fmt.Errorf("oh no") },
|
||||||
|
Inplace: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
exit := p.main([]string{path1}, os.Stdin, os.Stdout, os.Stderr)
|
||||||
|
|
||||||
|
require.Equal(t, -1, exit)
|
||||||
|
|
||||||
|
v1, err := ioutil.ReadFile(path1)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, "content 1", string(v1))
|
||||||
|
}
|
||||||
|
|
||||||
|
func dummyFileFn(r io.Reader, w io.Writer) error {
|
||||||
|
b, err := ioutil.ReadAll(r)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
v := strings.SplitN(string(b), " ", 2)[1]
|
||||||
|
_, err = w.Write([]byte(v))
|
||||||
|
return err
|
||||||
|
}
|
||||||
@@ -927,6 +927,29 @@ func TestUnmarshalMapWithTypedKey(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalTypeTableHeader(t *testing.T) {
|
||||||
|
testToml := []byte(`
|
||||||
|
[test]
|
||||||
|
a = 1
|
||||||
|
`)
|
||||||
|
|
||||||
|
type header string
|
||||||
|
var result map[header]map[string]int
|
||||||
|
err := toml.Unmarshal(testToml, &result)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Received unexpected error: %s", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
expected := map[header]map[string]int{
|
||||||
|
"test": map[string]int{"a": 1},
|
||||||
|
}
|
||||||
|
|
||||||
|
if !reflect.DeepEqual(result, expected) {
|
||||||
|
t.Errorf("Bad unmarshal: expected %v, got %v", expected, result)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestUnmarshalNonPointer(t *testing.T) {
|
func TestUnmarshalNonPointer(t *testing.T) {
|
||||||
a := 1
|
a := 1
|
||||||
err := toml.Unmarshal([]byte{}, a)
|
err := toml.Unmarshal([]byte{}, a)
|
||||||
@@ -1925,7 +1948,7 @@ func decoder(doc string) *toml.Decoder {
|
|||||||
|
|
||||||
func strictDecoder(doc string) *toml.Decoder {
|
func strictDecoder(doc string) *toml.Decoder {
|
||||||
d := decoder(doc)
|
d := decoder(doc)
|
||||||
d.SetStrict(true)
|
d.DisallowUnknownFields()
|
||||||
return d
|
return d
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+30
-8
@@ -555,16 +555,25 @@ type table struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *table) pushKV(k string, v reflect.Value, options valueOptions) {
|
func (t *table) pushKV(k string, v reflect.Value, options valueOptions) {
|
||||||
|
for _, e := range t.kvs {
|
||||||
|
if e.Key == k {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
t.kvs = append(t.kvs, entry{Key: k, Value: v, Options: options})
|
t.kvs = append(t.kvs, entry{Key: k, Value: v, Options: options})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *table) pushTable(k string, v reflect.Value, options valueOptions) {
|
func (t *table) pushTable(k string, v reflect.Value, options valueOptions) {
|
||||||
|
for _, e := range t.tables {
|
||||||
|
if e.Key == k {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
t.tables = append(t.tables, entry{Key: k, Value: v, Options: options})
|
t.tables = append(t.tables, entry{Key: k, Value: v, Options: options})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (enc *Encoder) encodeStruct(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
|
func walkStruct(ctx encoderCtx, t *table, v reflect.Value) {
|
||||||
var t table
|
|
||||||
|
|
||||||
// TODO: cache this
|
// TODO: cache this
|
||||||
typ := v.Type()
|
typ := v.Type()
|
||||||
for i := 0; i < typ.NumField(); i++ {
|
for i := 0; i < typ.NumField(); i++ {
|
||||||
@@ -575,8 +584,6 @@ func (enc *Encoder) encodeStruct(b []byte, ctx encoderCtx, v reflect.Value) ([]b
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
k := fieldType.Name
|
|
||||||
|
|
||||||
tag := fieldType.Tag.Get("toml")
|
tag := fieldType.Tag.Get("toml")
|
||||||
|
|
||||||
// special field name to skip field
|
// special field name to skip field
|
||||||
@@ -584,13 +591,22 @@ func (enc *Encoder) encodeStruct(b []byte, ctx encoderCtx, v reflect.Value) ([]b
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
name, opts := parseTag(tag)
|
k, opts := parseTag(tag)
|
||||||
if isValidName(name) {
|
if !isValidName(k) {
|
||||||
k = name
|
k = ""
|
||||||
}
|
}
|
||||||
|
|
||||||
f := v.Field(i)
|
f := v.Field(i)
|
||||||
|
|
||||||
|
if k == "" {
|
||||||
|
if fieldType.Anonymous {
|
||||||
|
walkStruct(ctx, t, f)
|
||||||
|
continue
|
||||||
|
} else {
|
||||||
|
k = fieldType.Name
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if isNil(f) {
|
if isNil(f) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
@@ -607,6 +623,12 @@ func (enc *Encoder) encodeStruct(b []byte, ctx encoderCtx, v reflect.Value) ([]b
|
|||||||
t.pushTable(k, f, options)
|
t.pushTable(k, f, options)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (enc *Encoder) encodeStruct(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
|
||||||
|
var t table
|
||||||
|
|
||||||
|
walkStruct(ctx, &t, v)
|
||||||
|
|
||||||
return enc.encodeTable(b, ctx, t)
|
return enc.encodeTable(b, ctx, t)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -947,6 +947,70 @@ func TestIssue678(t *testing.T) {
|
|||||||
require.Equal(t, cfg, cfg2)
|
require.Equal(t, cfg, cfg2)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestMarshalNestedAnonymousStructs(t *testing.T) {
|
||||||
|
type Embedded struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
Top struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
} `toml:"top" json:"top"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Named struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var doc struct {
|
||||||
|
Embedded
|
||||||
|
Named `toml:"named" json:"named"`
|
||||||
|
Anonymous struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
} `toml:"anonymous" json:"anonymous"`
|
||||||
|
}
|
||||||
|
|
||||||
|
expected := `value = ''
|
||||||
|
[top]
|
||||||
|
value = ''
|
||||||
|
|
||||||
|
[named]
|
||||||
|
value = ''
|
||||||
|
|
||||||
|
[anonymous]
|
||||||
|
value = ''
|
||||||
|
|
||||||
|
`
|
||||||
|
|
||||||
|
result, err := toml.Marshal(doc)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, expected, string(result))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMarshalNestedAnonymousStructs_DuplicateField(t *testing.T) {
|
||||||
|
type Embedded struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
Top struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
} `toml:"top" json:"top"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var doc struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
Embedded
|
||||||
|
}
|
||||||
|
doc.Embedded.Value = "shadowed"
|
||||||
|
doc.Value = "shadows"
|
||||||
|
|
||||||
|
expected := `value = 'shadows'
|
||||||
|
[top]
|
||||||
|
value = ''
|
||||||
|
|
||||||
|
`
|
||||||
|
|
||||||
|
result, err := toml.Marshal(doc)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, expected, string(result))
|
||||||
|
}
|
||||||
|
|
||||||
func ExampleMarshal() {
|
func ExampleMarshal() {
|
||||||
type MyConfig struct {
|
type MyConfig struct {
|
||||||
Version int
|
Version int
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/pelletier/go-toml/v2"
|
"github.com/pelletier/go-toml/v2"
|
||||||
"github.com/pelletier/go-toml/v2/testsuite"
|
"github.com/pelletier/go-toml/v2/internal/testsuite"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
+126
-25
@@ -1,4 +1,4 @@
|
|||||||
// Generated by tomltestgen for toml-test ref master on 2021-11-08T22:33:24-05:00
|
// Generated by tomltestgen for toml-test ref master on 2021-12-31T17:10:15-05:00
|
||||||
package toml_test
|
package toml_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -70,6 +70,16 @@ func TestTOMLTest_Invalid_Bool_WrongCaseTrue(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Control_BareNull(t *testing.T) {
|
||||||
|
input := "bare-null = \"some value\" \x00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Control_CommentCr(t *testing.T) {
|
||||||
|
input := "comment-cr = \"Carriage return in comment\" # \ra=1\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Control_CommentDel(t *testing.T) {
|
func TestTOMLTest_Invalid_Control_CommentDel(t *testing.T) {
|
||||||
input := "comment-del = \"0x7f\" # \u007f\n"
|
input := "comment-del = \"0x7f\" # \u007f\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -175,33 +185,73 @@ func TestTOMLTest_Invalid_Control_StringUs(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_ImpossibleDate(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_HourOver(t *testing.T) {
|
||||||
input := "d = 2006-01-50T00:00:00Z\n"
|
input := "# time-hour = 2DIGIT ; 00-23\nd = 2006-01-01T24:00:00-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_MdayOver(t *testing.T) {
|
||||||
|
input := "# date-mday = 2DIGIT ; 01-28, 01-29, 01-30, 01-31 based on\n# ; month/year\nd = 2006-01-32T00:00:00-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_MdayUnder(t *testing.T) {
|
||||||
|
input := "# date-mday = 2DIGIT ; 01-28, 01-29, 01-30, 01-31 based on\n# ; month/year\nd = 2006-01-00T00:00:00-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_MinuteOver(t *testing.T) {
|
||||||
|
input := "# time-minute = 2DIGIT ; 00-59\nd = 2006-01-01T00:60:00-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_MonthOver(t *testing.T) {
|
||||||
|
input := "# date-month = 2DIGIT ; 01-12\nd = 2006-13-01T00:00:00-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_MonthUnder(t *testing.T) {
|
||||||
|
input := "# date-month = 2DIGIT ; 01-12\nd = 2007-00-01T00:00:00-00:00\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_NoLeadsWithMilli(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_NoLeadsWithMilli(t *testing.T) {
|
||||||
input := "with-milli = 1987-07-5T17:45:00.12Z\n"
|
input := "# Day \"5\" instead of \"05\"; the leading zero is required.\nwith-milli = 1987-07-5T17:45:00.12Z\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_NoLeads(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_NoLeads(t *testing.T) {
|
||||||
input := "no-leads = 1987-7-05T17:45:00Z\n"
|
input := "# Month \"7\" instead of \"07\"; the leading zero is required.\nno-leads = 1987-7-05T17:45:00Z\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_NoSecs(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_NoSecs(t *testing.T) {
|
||||||
input := "no-secs = 1987-07-05T17:45Z\n"
|
input := "# No seconds in time.\nno-secs = 1987-07-05T17:45Z\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_NoT(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_NoT(t *testing.T) {
|
||||||
input := "no-t = 1987-07-0517:45:00Z\n"
|
input := "# No \"t\" or \"T\" between the date and time.\nno-t = 1987-07-0517:45:00Z\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_SecondOver(t *testing.T) {
|
||||||
|
input := "# time-second = 2DIGIT ; 00-58, 00-59, 00-60 based on leap second\n# ; rules\nd = 2006-01-01T00:00:61-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_TimeNoLeads2(t *testing.T) {
|
||||||
|
input := "# Leading 0 is always required.\nd = 01:32:0\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_TimeNoLeads(t *testing.T) {
|
||||||
|
input := "# Leading 0 is always required.\nd = 1:32:00\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_TrailingT(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_TrailingT(t *testing.T) {
|
||||||
input := "d = 2006-01-30T\n"
|
input := "# Date cannot end with trailing T\nd = 2006-01-30T\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -435,6 +485,11 @@ func TestTOMLTest_Invalid_InlineTable_NoComma(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_InlineTable_Overwrite(t *testing.T) {
|
||||||
|
input := "a.b=0\n# Since table \"a\" is already defined, it can't be replaced by an inline table.\na={}\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_InlineTable_TrailingComma(t *testing.T) {
|
func TestTOMLTest_Invalid_InlineTable_TrailingComma(t *testing.T) {
|
||||||
input := "# A terminating comma (also called trailing comma) is not permitted after the\n# last key/value pair in an inline table\nabc = { abc = 123, }\n"
|
input := "# A terminating comma (also called trailing comma) is not permitted after the\n# last key/value pair in an inline table\nabc = { abc = 123, }\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -515,6 +570,11 @@ func TestTOMLTest_Invalid_Integer_LeadingZero2(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Integer_LeadingZero3(t *testing.T) {
|
||||||
|
input := "leading-zero-3 = 0_0\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Integer_LeadingZeroSign1(t *testing.T) {
|
func TestTOMLTest_Invalid_Integer_LeadingZeroSign1(t *testing.T) {
|
||||||
input := "leading-zero-sign-1 = -01\n"
|
input := "leading-zero-sign-1 = -01\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -525,6 +585,11 @@ func TestTOMLTest_Invalid_Integer_LeadingZeroSign2(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Integer_LeadingZeroSign3(t *testing.T) {
|
||||||
|
input := "leading-zero-sign-3 = +0_1\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Integer_NegativeBin(t *testing.T) {
|
func TestTOMLTest_Invalid_Integer_NegativeBin(t *testing.T) {
|
||||||
input := "negative-bin = -0b11010110\n"
|
input := "negative-bin = -0b11010110\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -730,11 +795,16 @@ func TestTOMLTest_Invalid_String_BadConcat(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_String_BadEscape(t *testing.T) {
|
func TestTOMLTest_Invalid_String_BadEscape1(t *testing.T) {
|
||||||
input := "invalid-escape = \"This string has a bad \\a escape character.\"\n"
|
input := "invalid-escape = \"This string has a bad \\a escape character.\"\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_String_BadEscape2(t *testing.T) {
|
||||||
|
input := "invalid-escape = \"This string has a bad \\ escape character.\"\n\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_String_BadMultiline(t *testing.T) {
|
func TestTOMLTest_Invalid_String_BadMultiline(t *testing.T) {
|
||||||
input := "multi = \"first line\nsecond line\"\n"
|
input := "multi = \"first line\nsecond line\"\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -805,6 +875,21 @@ func TestTOMLTest_Invalid_String_MissingQuotes(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_String_MultilineBadEscape1(t *testing.T) {
|
||||||
|
input := "k = \"\"\"t\\a\"\"\"\n\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_String_MultilineBadEscape2(t *testing.T) {
|
||||||
|
input := "# \\<Space> is not a valid escape.\nk = \"\"\"t\\ t\"\"\"\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_String_MultilineBadEscape3(t *testing.T) {
|
||||||
|
input := "# \\<Space> is not a valid escape.\nk = \"\"\"t\\ \"\"\"\n\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_String_MultilineEscapeSpace(t *testing.T) {
|
func TestTOMLTest_Invalid_String_MultilineEscapeSpace(t *testing.T) {
|
||||||
input := "a = \"\"\"\n foo \\ \\n\n bar\"\"\"\n"
|
input := "a = \"\"\"\n foo \\ \\n\n bar\"\"\"\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -845,6 +930,16 @@ func TestTOMLTest_Invalid_String_WrongClose(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Table_AppendWithDottedKeys1(t *testing.T) {
|
||||||
|
input := "# First a.b.c defines a table: a.b.c = {z=9}\n#\n# Then we define a.b.c.t = \"str\" to add a str to the above table, making it:\n#\n# a.b.c = {z=9, t=\"...\"}\n#\n# While this makes sense, logically, it was decided this is not valid TOML as\n# it's too confusing/convoluted.\n# \n# See: https://github.com/toml-lang/toml/issues/846\n# https://github.com/toml-lang/toml/pull/859\n\n[a.b.c]\n z = 9\n\n[a]\n b.c.t = \"Using dotted keys to add to [a.b.c] after explicitly defining it above is not allowed\"\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Table_AppendWithDottedKeys2(t *testing.T) {
|
||||||
|
input := "# This is the same issue as in injection-1.toml, except that nests one level\n# deeper. See that file for a more complete description.\n\n[a.b.c.d]\n z = 9\n\n[a]\n b.c.d.k.t = \"Using dotted keys to add to [a.b.c.d] after explicitly defining it above is not allowed\"\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Table_ArrayEmpty(t *testing.T) {
|
func TestTOMLTest_Invalid_Table_ArrayEmpty(t *testing.T) {
|
||||||
input := "[[]]\nname = \"Born to Run\"\n"
|
input := "[[]]\nname = \"Born to Run\"\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -860,6 +955,16 @@ func TestTOMLTest_Invalid_Table_ArrayMissingBracket(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Table_DuplicateKeyDottedTable(t *testing.T) {
|
||||||
|
input := "[fruit]\napple.color = \"red\"\n\n[fruit.apple] # INVALID\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Table_DuplicateKeyDottedTable2(t *testing.T) {
|
||||||
|
input := "[fruit]\napple.taste.sweet = true\n\n[fruit.apple.taste] # INVALID\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Table_DuplicateKeyTable(t *testing.T) {
|
func TestTOMLTest_Invalid_Table_DuplicateKeyTable(t *testing.T) {
|
||||||
input := "[fruit]\ntype = \"apple\"\n\n[fruit.type]\napple = \"yes\"\n"
|
input := "[fruit]\ntype = \"apple\"\n\n[fruit.type]\napple = \"yes\"\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -895,16 +1000,6 @@ func TestTOMLTest_Invalid_Table_EqualsSign(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Table_Injection1(t *testing.T) {
|
|
||||||
input := "[a.b.c]\n z = 9\n[a]\n b.c.t = \"Using dotted keys to add to [a.b.c] after explicitly defining it above is not allowed\"\n \n# see https://github.com/toml-lang/toml/issues/846\n"
|
|
||||||
testgenInvalid(t, input)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Table_Injection2(t *testing.T) {
|
|
||||||
input := "[a.b.c.d]\n z = 9\n[a]\n b.c.d.k.t = \"Using dotted keys to add to [a.b.c.d] after explicitly defining it above is not allowed\"\n \n# see https://github.com/toml-lang/toml/issues/846\n"
|
|
||||||
testgenInvalid(t, input)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Table_Llbrace(t *testing.T) {
|
func TestTOMLTest_Invalid_Table_Llbrace(t *testing.T) {
|
||||||
input := "[ [table]]\n"
|
input := "[ [table]]\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -1071,8 +1166,14 @@ func TestTOMLTest_Valid_Comment_AtEof2(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Valid_Comment_Everywhere(t *testing.T) {
|
func TestTOMLTest_Valid_Comment_Everywhere(t *testing.T) {
|
||||||
input := "# Top comment.\n # Top comment.\n# Top comment.\n\n# [no-extraneous-groups-please]\n\n[group] # Comment\nanswer = 42 # Comment\n# no-extraneous-keys-please = 999\n# Inbetween comment.\nmore = [ # Comment\n # What about multiple # comments?\n # Can you handle it?\n #\n # Evil.\n# Evil.\n 42, 42, # Comments within arrays are fun.\n # What about multiple # comments?\n # Can you handle it?\n #\n # Evil.\n# Evil.\n# ] Did I fool you?\n] # Hopefully not.\n\n# Make sure the space between the datetime and \"#\" isn't lexed.\nd = 1979-05-27T07:32:12-07:00 # c\n"
|
input := "# Top comment.\n # Top comment.\n# Top comment.\n\n# [no-extraneous-groups-please]\n\n[group] # Comment\nanswer = 42 # Comment\n# no-extraneous-keys-please = 999\n# Inbetween comment.\nmore = [ # Comment\n # What about multiple # comments?\n # Can you handle it?\n #\n # Evil.\n# Evil.\n 42, 42, # Comments within arrays are fun.\n # What about multiple # comments?\n # Can you handle it?\n #\n # Evil.\n# Evil.\n# ] Did I fool you?\n] # Hopefully not.\n\n# Make sure the space between the datetime and \"#\" isn't lexed.\ndt = 1979-05-27T07:32:12-07:00 # c\nd = 1979-05-27 # Comment\n"
|
||||||
jsonRef := "{\n \"group\": {\n \"answer\": {\n \"type\": \"integer\",\n \"value\": \"42\"\n },\n \"d\": {\n \"type\": \"datetime\",\n \"value\": \"1979-05-27T07:32:12-07:00\"\n },\n \"more\": [\n {\n \"type\": \"integer\",\n \"value\": \"42\"\n },\n {\n \"type\": \"integer\",\n \"value\": \"42\"\n }\n ]\n }\n}\n"
|
jsonRef := "{\n \"group\": {\n \"answer\": {\n \"type\": \"integer\",\n \"value\": \"42\"\n },\n \"dt\": {\n \"type\": \"datetime\",\n \"value\": \"1979-05-27T07:32:12-07:00\"\n },\n \"d\": {\n \"type\": \"date-local\",\n \"value\": \"1979-05-27\"\n },\n \"more\": [\n {\n \"type\": \"integer\",\n \"value\": \"42\"\n },\n {\n \"type\": \"integer\",\n \"value\": \"42\"\n }\n ]\n }\n}\n"
|
||||||
|
testgenValid(t, input, jsonRef)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Valid_Comment_Noeol(t *testing.T) {
|
||||||
|
input := "# single comment without any eol characters"
|
||||||
|
jsonRef := "{}\n"
|
||||||
testgenValid(t, input, jsonRef)
|
testgenValid(t, input, jsonRef)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1107,8 +1208,8 @@ func TestTOMLTest_Valid_Datetime_Local(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Valid_Datetime_Milliseconds(t *testing.T) {
|
func TestTOMLTest_Valid_Datetime_Milliseconds(t *testing.T) {
|
||||||
input := "utc1 = 1987-07-05T17:45:56.123456Z\nutc2 = 1987-07-05T17:45:56.6Z\nwita1 = 1987-07-05T17:45:56.123456+08:00\nwita2 = 1987-07-05T17:45:56.6+08:00\n"
|
input := "utc1 = 1987-07-05T17:45:56.1234Z\nutc2 = 1987-07-05T17:45:56.6Z\nwita1 = 1987-07-05T17:45:56.1234+08:00\nwita2 = 1987-07-05T17:45:56.6+08:00\n"
|
||||||
jsonRef := "{\n \"utc1\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.123456Z\"\n },\n \"utc2\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.600000Z\"\n },\n \"wita1\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.123456+08:00\"\n },\n \"wita2\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.600000+08:00\"\n }\n}\n"
|
jsonRef := "{\n \"utc1\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.1234Z\"\n },\n \"utc2\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.6000Z\"\n },\n \"wita1\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.1234+08:00\"\n },\n \"wita2\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.6000+08:00\"\n }\n}\n"
|
||||||
testgenValid(t, input, jsonRef)
|
testgenValid(t, input, jsonRef)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1395,7 +1496,7 @@ func TestTOMLTest_Valid_String_MultilineQuotes(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Valid_String_Multiline(t *testing.T) {
|
func TestTOMLTest_Valid_String_Multiline(t *testing.T) {
|
||||||
input := "# NOTE: this file includes some literal tab characters.\n\nmultiline_empty_one = \"\"\"\"\"\"\nmultiline_empty_two = \"\"\"\n\"\"\"\nmultiline_empty_three = \"\"\"\\\n \"\"\"\nmultiline_empty_four = \"\"\"\\\n \\\n \\ \n \"\"\"\n\nequivalent_one = \"The quick brown fox jumps over the lazy dog.\"\nequivalent_two = \"\"\"\nThe quick brown \\\n\n\n fox jumps over \\\n the lazy dog.\"\"\"\n\nequivalent_three = \"\"\"\\\n The quick brown \\\n fox jumps over \\\n the lazy dog.\\\n \"\"\"\n\nwhitespace-after-bs = \"\"\"\\\n The quick brown \\\n fox jumps over \\ \n the lazy dog.\\\t\n \"\"\"\n\nno-space = \"\"\"a\\\n b\"\"\"\n\nkeep-ws-before = \"\"\"a \t\\\n b\"\"\"\n\nescape-bs-1 = \"\"\"a \\\\\nb\"\"\"\n\nescape-bs-2 = \"\"\"a \\\\\\\nb\"\"\"\n\nescape-bs-3 = \"\"\"a \\\\\\\\\n b\"\"\"\n"
|
input := "# NOTE: this file includes some literal tab characters.\n\nmultiline_empty_one = \"\"\"\"\"\"\n\n# A newline immediately following the opening delimiter will be trimmed.\nmultiline_empty_two = \"\"\"\n\"\"\"\n\n# \\ at the end of line trims newlines as well; note that last \\ is followed by\n# two spaces, which are ignored.\nmultiline_empty_three = \"\"\"\\\n \"\"\"\nmultiline_empty_four = \"\"\"\\\n \\\n \\ \n \"\"\"\n\nequivalent_one = \"The quick brown fox jumps over the lazy dog.\"\nequivalent_two = \"\"\"\nThe quick brown \\\n\n\n fox jumps over \\\n the lazy dog.\"\"\"\n\nequivalent_three = \"\"\"\\\n The quick brown \\\n fox jumps over \\\n the lazy dog.\\\n \"\"\"\n\nwhitespace-after-bs = \"\"\"\\\n The quick brown \\\n fox jumps over \\ \n the lazy dog.\\\t\n \"\"\"\n\nno-space = \"\"\"a\\\n b\"\"\"\n\n# Has tab character.\nkeep-ws-before = \"\"\"a \t\\\n b\"\"\"\n\nescape-bs-1 = \"\"\"a \\\\\nb\"\"\"\n\nescape-bs-2 = \"\"\"a \\\\\\\nb\"\"\"\n\nescape-bs-3 = \"\"\"a \\\\\\\\\n b\"\"\"\n"
|
||||||
jsonRef := "{\n \"equivalent_one\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"equivalent_three\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"equivalent_two\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"escape-bs-1\": {\n \"type\": \"string\",\n \"value\": \"a \\\\\\nb\"\n },\n \"escape-bs-2\": {\n \"type\": \"string\",\n \"value\": \"a \\\\b\"\n },\n \"escape-bs-3\": {\n \"type\": \"string\",\n \"value\": \"a \\\\\\\\\\n b\"\n },\n \"keep-ws-before\": {\n \"type\": \"string\",\n \"value\": \"a \\tb\"\n },\n \"multiline_empty_four\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_one\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_three\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_two\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"no-space\": {\n \"type\": \"string\",\n \"value\": \"ab\"\n },\n \"whitespace-after-bs\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n }\n}\n"
|
jsonRef := "{\n \"equivalent_one\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"equivalent_three\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"equivalent_two\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"escape-bs-1\": {\n \"type\": \"string\",\n \"value\": \"a \\\\\\nb\"\n },\n \"escape-bs-2\": {\n \"type\": \"string\",\n \"value\": \"a \\\\b\"\n },\n \"escape-bs-3\": {\n \"type\": \"string\",\n \"value\": \"a \\\\\\\\\\n b\"\n },\n \"keep-ws-before\": {\n \"type\": \"string\",\n \"value\": \"a \\tb\"\n },\n \"multiline_empty_four\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_one\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_three\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_two\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"no-space\": {\n \"type\": \"string\",\n \"value\": \"ab\"\n },\n \"whitespace-after-bs\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n }\n}\n"
|
||||||
testgenValid(t, input, jsonRef)
|
testgenValid(t, input, jsonRef)
|
||||||
}
|
}
|
||||||
@@ -1407,7 +1508,7 @@ func TestTOMLTest_Valid_String_Nl(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Valid_String_RawMultiline(t *testing.T) {
|
func TestTOMLTest_Valid_String_RawMultiline(t *testing.T) {
|
||||||
input := "oneline = '''This string has a ' quote character.'''\nfirstnl = '''\nThis string has a ' quote character.'''\nmultiline = '''\nThis string\nhas ' a quote character\nand more than\none newline\nin it.'''\n"
|
input := "# Single ' should be allowed.\noneline = '''This string has a ' quote character.'''\n\n# A newline immediately following the opening delimiter will be trimmed.\nfirstnl = '''\nThis string has a ' quote character.'''\n\n# All other whitespace and newline characters remain intact.\nmultiline = '''\nThis string\nhas ' a quote character\nand more than\none newline\nin it.'''\n"
|
||||||
jsonRef := "{\n \"firstnl\": {\n \"type\": \"string\",\n \"value\": \"This string has a ' quote character.\"\n },\n \"multiline\": {\n \"type\": \"string\",\n \"value\": \"This string\\nhas ' a quote character\\nand more than\\none newline\\nin it.\"\n },\n \"oneline\": {\n \"type\": \"string\",\n \"value\": \"This string has a ' quote character.\"\n }\n}\n"
|
jsonRef := "{\n \"firstnl\": {\n \"type\": \"string\",\n \"value\": \"This string has a ' quote character.\"\n },\n \"multiline\": {\n \"type\": \"string\",\n \"value\": \"This string\\nhas ' a quote character\\nand more than\\none newline\\nin it.\"\n },\n \"oneline\": {\n \"type\": \"string\",\n \"value\": \"This string has a ' quote character.\"\n }\n}\n"
|
||||||
testgenValid(t, input, jsonRef)
|
testgenValid(t, input, jsonRef)
|
||||||
}
|
}
|
||||||
|
|||||||
+12
-11
@@ -42,21 +42,22 @@ func NewDecoder(r io.Reader) *Decoder {
|
|||||||
return &Decoder{r: r}
|
return &Decoder{r: r}
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetStrict toggles decoding in stict mode.
|
// DisallowUnknownFields causes the Decoder to return an error when the
|
||||||
|
// destination is a struct and the input contains a key that does not match a
|
||||||
|
// non-ignored field.
|
||||||
//
|
//
|
||||||
// When the decoder is in strict mode, it will record fields from the document
|
// In that case, the Decoder returns a StrictMissingError that can be used to
|
||||||
// that could not be set on the target value. In that case, the decoder returns
|
// retrieve the individual errors as well as generate a human readable
|
||||||
// a StrictMissingError that can be used to retrieve the individual errors as
|
// description of the missing fields.
|
||||||
// well as generate a human readable description of the missing fields.
|
func (d *Decoder) DisallowUnknownFields() *Decoder {
|
||||||
func (d *Decoder) SetStrict(strict bool) *Decoder {
|
d.strict = true
|
||||||
d.strict = strict
|
|
||||||
return d
|
return d
|
||||||
}
|
}
|
||||||
|
|
||||||
// Decode the whole content of r into v.
|
// Decode the whole content of r into v.
|
||||||
//
|
//
|
||||||
// By default, values in the document that don't exist in the target Go value
|
// By default, values in the document that don't exist in the target Go value
|
||||||
// are ignored. See Decoder.SetStrict() to change this behavior.
|
// are ignored. See Decoder.DisallowUnknownFields() to change this behavior.
|
||||||
//
|
//
|
||||||
// When a TOML local date, time, or date-time is decoded into a time.Time, its
|
// When a TOML local date, time, or date-time is decoded into a time.Time, its
|
||||||
// value is represented in time.Local timezone. Otherwise the approriate Local*
|
// value is represented in time.Local timezone. Otherwise the approriate Local*
|
||||||
@@ -411,9 +412,10 @@ func (d *decoder) handleKeyPart(key ast.Iterator, v reflect.Value, nextFn handle
|
|||||||
elem = v.Elem()
|
elem = v.Elem()
|
||||||
return d.handleKeyPart(key, elem, nextFn, makeFn)
|
return d.handleKeyPart(key, elem, nextFn, makeFn)
|
||||||
case reflect.Map:
|
case reflect.Map:
|
||||||
|
vt := v.Type()
|
||||||
|
|
||||||
// Create the key for the map element. For now assume it's a string.
|
// Create the key for the map element. Convert to key type.
|
||||||
mk := reflect.ValueOf(string(key.Node().Data))
|
mk := reflect.ValueOf(string(key.Node().Data)).Convert(vt.Key())
|
||||||
|
|
||||||
// If the map does not exist, create it.
|
// If the map does not exist, create it.
|
||||||
if v.IsNil() {
|
if v.IsNil() {
|
||||||
@@ -430,7 +432,6 @@ func (d *decoder) handleKeyPart(key ast.Iterator, v reflect.Value, nextFn handle
|
|||||||
// map[string]interface{} or a []interface{} depending on whether
|
// map[string]interface{} or a []interface{} depending on whether
|
||||||
// this is the last part of the array table key.
|
// this is the last part of the array table key.
|
||||||
|
|
||||||
vt := v.Type()
|
|
||||||
t := vt.Elem()
|
t := vt.Elem()
|
||||||
if t.Kind() == reflect.Interface {
|
if t.Kind() == reflect.Interface {
|
||||||
mv = makeFn()
|
mv = makeFn()
|
||||||
|
|||||||
+8
-4
@@ -16,7 +16,7 @@ import (
|
|||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
func ExampleDecoder_SetStrict() {
|
func ExampleDecoder_DisallowUnknownFields() {
|
||||||
type S struct {
|
type S struct {
|
||||||
Key1 string
|
Key1 string
|
||||||
Key3 string
|
Key3 string
|
||||||
@@ -28,7 +28,7 @@ key3 = "value3"
|
|||||||
`
|
`
|
||||||
r := strings.NewReader(doc)
|
r := strings.NewReader(doc)
|
||||||
d := toml.NewDecoder(r)
|
d := toml.NewDecoder(r)
|
||||||
d.SetStrict(true)
|
d.DisallowUnknownFields()
|
||||||
s := S{}
|
s := S{}
|
||||||
err := d.Decode(&s)
|
err := d.Decode(&s)
|
||||||
|
|
||||||
@@ -279,6 +279,11 @@ func TestUnmarshal_Floats(t *testing.T) {
|
|||||||
input: `1.0_e2`,
|
input: `1.0_e2`,
|
||||||
err: true,
|
err: true,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
desc: "leading zero in positive float",
|
||||||
|
input: `+0_0.0`,
|
||||||
|
err: true,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
type doc struct {
|
type doc struct {
|
||||||
@@ -1901,7 +1906,7 @@ bar = 42
|
|||||||
t.Run("strict", func(t *testing.T) {
|
t.Run("strict", func(t *testing.T) {
|
||||||
r := strings.NewReader(e.input)
|
r := strings.NewReader(e.input)
|
||||||
d := toml.NewDecoder(r)
|
d := toml.NewDecoder(r)
|
||||||
d.SetStrict(true)
|
d.DisallowUnknownFields()
|
||||||
x := e.target
|
x := e.target
|
||||||
if x == nil {
|
if x == nil {
|
||||||
x = &struct{}{}
|
x = &struct{}{}
|
||||||
@@ -1919,7 +1924,6 @@ bar = 42
|
|||||||
t.Run("default", func(t *testing.T) {
|
t.Run("default", func(t *testing.T) {
|
||||||
r := strings.NewReader(e.input)
|
r := strings.NewReader(e.input)
|
||||||
d := toml.NewDecoder(r)
|
d := toml.NewDecoder(r)
|
||||||
d.SetStrict(false)
|
|
||||||
x := e.target
|
x := e.target
|
||||||
if x == nil {
|
if x == nil {
|
||||||
x = &struct{}{}
|
x = &struct{}{}
|
||||||
|
|||||||
Reference in New Issue
Block a user