borgmatic-collective/borgmatic
borgmatic-collective/borgmatic
9
74
Fork 55
Code Issues 55 Pull requests 4 Releases 160 Packages 1 Activity Actions 1

Poor error reporting for bad YAML includes #196

New issue
Closed
opened 2019-06-16 22:52:09 +00:00 by elho · 4 comments
elho commented 2019-06-16 22:52:09 +00:00
Copy link

Given these config files that wrongly try a (dictionary) YAML merge include on a item that is a list...

bad.yaml:

location:
  source_directories:
    - /test

  repositories:
    <<: !include ./repositories.yaml

repositories.yaml:

- foo@bar:qux
- foo@baz:quux

Both borgmatic and validate-borgmatic-config give this error message:

bad.yaml: Error parsing configuration file
too many values to unpack (expected 2)

Unlike for other errors, theer's no indication what or where in the file the error is.

Given these config files that wrongly try a (dictionary) YAML merge include on a item that is a list... `bad.yaml`: ``` location: source_directories: - /test repositories: <<: !include ./repositories.yaml ``` `repositories.yaml`: ``` - foo@bar:qux - foo@baz:quux ``` Both `borgmatic` and `validate-borgmatic-config` give this error message: ``` bad.yaml: Error parsing configuration file too many values to unpack (expected 2) ``` Unlike for other errors, theer's no indication what or where in the file the error is.
witten commented 2019-06-16 23:25:07 +00:00
Owner
Copy link

Thanks for reporting. This error is coming from deep within ruamel.yaml, but we may be able to do something about it.

Thanks for reporting. This error is coming from deep within `ruamel.yaml`, but we may be able to do something about it.
witten commented 2019-06-17 00:41:19 +00:00
Owner
Copy link

Well, I've got a potential fix (needs more testing) that results in the following better error message:

bad.yaml: Error parsing configuration file
An error occurred while parsing a configuration file at bad.yaml:
while constructing a mapping
  in "bad.yaml", line 6, column 5
expected a mapping for merging, but found scalar
Well, I've got a potential fix (needs more testing) that results in the following better error message: ```console bad.yaml: Error parsing configuration file An error occurred while parsing a configuration file at bad.yaml: while constructing a mapping in "bad.yaml", line 6, column 5 expected a mapping for merging, but found scalar ```
👍 1
witten commented 2019-06-17 04:35:58 +00:00
Owner
Copy link

Fixed in master. The fix will go out as part of the next release. I do really appreciate tickets on these sorts of things, as it helps me find and fix things that are unclear or just plain wrong that I may not know about.

Fixed in master. The fix will go out as part of the next release. I do really appreciate tickets on these sorts of things, as it helps me find and fix things that are unclear or just plain wrong that I may not know about.
witten commented 2019-06-17 19:18:52 +00:00
Owner
Copy link

Just released as part of borgmatic 1.3.7.

Just released as part of borgmatic 1.3.7.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
parallel-borgmatic
command-hook-steps
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.13
2.0.12
2.0.11
2.0.10
2.0.9
2.0.8
2.0.7
2.0.6
2.0.5
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
1.9.14
1.9.13
1.9.12
1.9.11
1.9.10
1.9.9
1.9.8
1.9.7
1.9.6
1.9.5
1.9.4
1.9.3
1.9.2
1.9.1
1.9.0
1.8.14
1.8.13
1.8.12
1.8.11
1.8.10
1.8.9
1.8.8
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.24
1.5.23
1.5.22
1.5.21
1.5.20
1.5.19
1.5.18
1.5.17
1.5.16
1.5.15
1.5.14
1.5.13
1.5.12
1.5.11
1.5.10
1.5.9
1.5.8
1.5.7
1.5.7.dev0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.22
1.4.21
1.4.20
1.4.19
1.4.18
1.4.17
1.4.16
1.4.15
1.4.14
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.26
1.3.25
1.3.24
1.3.23
1.3.22
1.3.21
1.3.20
1.3.19
1.3.18
1.3.17
1.3.16
1.3.15
1.3.14
1.3.13
1.3.12
1.3.11
1.3.10
1.3.9
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.18
1.2.17
1.2.16
1.2.15
1.2.14
1.2.13
1.2.12
1.2.11
1.2.10
1.2.9
1.2.8
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.15
1.1.14
1.1.13
1.1.12
1.1.11
1.1.10
1.1.9
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.3
1.0.2
1.0.1
1.0.0
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
Labels
Clear labels   
blocked

   
breaking

   
bug

   
data loss

   
design finalized

   
good first issue

   
new feature area

   
question / support

   
security

   
waiting for response
No labels
blocked
breaking
bug
data loss
design finalized
good first issue
new feature area
question / support
security
waiting for response
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
borgmatic-collective/borgmatic#196
No description provided.