TrueCloudLab/restic
16
0
Fork 2
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

Add file mode in symbolic notation to ls --json

Browse source 
This aligns `restic ls --json` with `restic find --json`, utilizing the same
naming.
This commit is contained in:
Manuel González 2021-11-13 14:37:03 +02:00
parent 4bf05d91a1
commit 212b2f651f
No known key found for this signature in database
GPG key ID: B10FDF745EB305C2
3 changed files with 37 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
changelog/unreleased/issue-3542 Normal file
View file

@ -0,0 +1,8 @@
Enhancement: Add file mode in symbolic notation to `ls --json`
Now `restic ls --json` provides mode in symbolic notation aligned
with `restic find --json`.
https://github.com/restic/restic/issues/3542
https://github.com/restic/restic/pull/3573
https://forum.restic.net/t/restic-ls-understanding-file-mode-with-json/4371

46
cmd/restic/cmd_ls.go
View file

@ -77,31 +77,33 @@ type lsSnapshot struct {
// Print node in our custom JSON format, followed by a newline. // Print node in our custom JSON format, followed by a newline.
func lsNodeJSON(enc *json.Encoder, path string, node *restic.Node) error { func lsNodeJSON(enc *json.Encoder, path string, node *restic.Node) error {
n := &struct { n := &struct {
Name string `json:"name"` Name string `json:"name"`
Type string `json:"type"` Type string `json:"type"`
Path string `json:"path"` Path string `json:"path"`
UID uint32 `json:"uid"` UID uint32 `json:"uid"`
GID uint32 `json:"gid"` GID uint32 `json:"gid"`
Size *uint64 `json:"size,omitempty"` Size *uint64 `json:"size,omitempty"`
Mode os.FileMode `json:"mode,omitempty"` Mode os.FileMode `json:"mode,omitempty"`
ModTime time.Time `json:"mtime,omitempty"` Permissions string `json:"permissions,omitempty"`
AccessTime time.Time `json:"atime,omitempty"` ModTime time.Time `json:"mtime,omitempty"`
ChangeTime time.Time `json:"ctime,omitempty"` AccessTime time.Time `json:"atime,omitempty"`
StructType string `json:"struct_type"` // "node" ChangeTime time.Time `json:"ctime,omitempty"`
StructType string `json:"struct_type"` // "node"
size uint64 // Target for Size pointer. size uint64 // Target for Size pointer.
}{ }{
Name: node.Name, Name: node.Name,
Type: node.Type, Type: node.Type,
Path: path, Path: path,
UID: node.UID, UID: node.UID,
GID: node.GID, GID: node.GID,
size: node.Size, size: node.Size,
Mode: node.Mode, Mode: node.Mode,
ModTime: node.ModTime, Permissions: node.Mode.String(),
AccessTime: node.AccessTime, ModTime: node.ModTime,
ChangeTime: node.ChangeTime, AccessTime: node.AccessTime,
StructType: "node", ChangeTime: node.ChangeTime,
StructType: "node",
} }
// Always print size for regular files, even when empty, // Always print size for regular files, even when empty,
// but never for other types. // but never for other types.

9
cmd/restic/cmd_ls_test.go
View file

@ -18,6 +18,7 @@ func TestLsNodeJSON(t *testing.T) {
expect string expect string
}{ }{
// Mode is omitted when zero. // Mode is omitted when zero.
// Permissions, by convention is "-" per mode bit
{ {
path: "/bar/baz", path: "/bar/baz",
Node: restic.Node{ Node: restic.Node{
@ -31,7 +32,7 @@ func TestLsNodeJSON(t *testing.T) {
Group: "nobodies", Group: "nobodies",
Links: 1, Links: 1,
}, },
expect: `{"name":"baz","type":"file","path":"/bar/baz","uid":10000000,"gid":20000000,"size":12345,"mtime":"0001-01-01T00:00:00Z","atime":"0001-01-01T00:00:00Z","ctime":"0001-01-01T00:00:00Z","struct_type":"node"}`, expect: `{"name":"baz","type":"file","path":"/bar/baz","uid":10000000,"gid":20000000,"size":12345,"permissions":"----------","mtime":"0001-01-01T00:00:00Z","atime":"0001-01-01T00:00:00Z","ctime":"0001-01-01T00:00:00Z","struct_type":"node"}`,
}, },
// Even empty files get an explicit size. // Even empty files get an explicit size.
@ -48,7 +49,7 @@ func TestLsNodeJSON(t *testing.T) {
Group: "not printed", Group: "not printed",
Links: 0xF00, Links: 0xF00,
}, },
expect: `{"name":"empty","type":"file","path":"/foo/empty","uid":1001,"gid":1001,"size":0,"mtime":"0001-01-01T00:00:00Z","atime":"0001-01-01T00:00:00Z","ctime":"0001-01-01T00:00:00Z","struct_type":"node"}`, expect: `{"name":"empty","type":"file","path":"/foo/empty","uid":1001,"gid":1001,"size":0,"permissions":"----------","mtime":"0001-01-01T00:00:00Z","atime":"0001-01-01T00:00:00Z","ctime":"0001-01-01T00:00:00Z","struct_type":"node"}`,
}, },
// Non-regular files do not get a size. // Non-regular files do not get a size.
@ -61,7 +62,7 @@ func TestLsNodeJSON(t *testing.T) {
Mode: os.ModeSymlink | 0777, Mode: os.ModeSymlink | 0777,
LinkTarget: "not printed", LinkTarget: "not printed",
}, },
expect: `{"name":"link","type":"symlink","path":"/foo/link","uid":0,"gid":0,"mode":134218239,"mtime":"0001-01-01T00:00:00Z","atime":"0001-01-01T00:00:00Z","ctime":"0001-01-01T00:00:00Z","struct_type":"node"}`, expect: `{"name":"link","type":"symlink","path":"/foo/link","uid":0,"gid":0,"mode":134218239,"permissions":"Lrwxrwxrwx","mtime":"0001-01-01T00:00:00Z","atime":"0001-01-01T00:00:00Z","ctime":"0001-01-01T00:00:00Z","struct_type":"node"}`,
}, },
{ {
@ -74,7 +75,7 @@ func TestLsNodeJSON(t *testing.T) {
AccessTime: time.Date(2021, 2, 3, 4, 5, 6, 7, time.UTC), AccessTime: time.Date(2021, 2, 3, 4, 5, 6, 7, time.UTC),
ChangeTime: time.Date(2022, 3, 4, 5, 6, 7, 8, time.UTC), ChangeTime: time.Date(2022, 3, 4, 5, 6, 7, 8, time.UTC),
}, },
expect: `{"name":"directory","type":"dir","path":"/some/directory","uid":0,"gid":0,"mode":2147484141,"mtime":"2020-01-02T03:04:05Z","atime":"2021-02-03T04:05:06.000000007Z","ctime":"2022-03-04T05:06:07.000000008Z","struct_type":"node"}`, expect: `{"name":"directory","type":"dir","path":"/some/directory","uid":0,"gid":0,"mode":2147484141,"permissions":"drwxr-xr-x","mtime":"2020-01-02T03:04:05Z","atime":"2021-02-03T04:05:06.000000007Z","ctime":"2022-03-04T05:06:07.000000008Z","struct_type":"node"}`,
}, },
} { } {
buf := new(bytes.Buffer) buf := new(bytes.Buffer)