]> git.notmuchmail.org Git - notmuch/blob - test/T160-json.sh
cli: implement structured output version 4
[notmuch] / test / T160-json.sh
1 #!/usr/bin/env bash
2 test_description="--format=json output"
3 . ./test-lib.sh || exit 1
4
5 test_begin_subtest "Show message: json"
6 add_message "[subject]=\"json-show-subject\"" "[date]=\"Sat, 01 Jan 2000 12:00:00 -0000\"" "[bcc]=\"test_suite+bcc@notmuchmail.org\"" "[reply-to]=\"test_suite+replyto@notmuchmail.org\"" "[body]=\"json-show-message\""
7 output=$(notmuch show --format=json "json-show-message")
8 test_expect_equal_json "$output" "[[[{\"id\": \"${gen_msg_id}\", \"match\": true, \"excluded\": false, \"filename\": [\"${gen_msg_filename}\"], \"timestamp\": 946728000, \"date_relative\": \"2000-01-01\", \"tags\": [\"inbox\",\"unread\"], \"headers\": {\"Subject\": \"json-show-subject\", \"From\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"To\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"Bcc\": \"test_suite+bcc@notmuchmail.org\", \"Reply-To\": \"test_suite+replyto@notmuchmail.org\", \"Date\": \"Sat, 01 Jan 2000 12:00:00 +0000\"}, \"body\": [{\"id\": 1, \"content-type\": \"text/plain\", \"content\": \"json-show-message\n\"}]}, []]]]"
9
10 # This should be the same output as above.
11 test_begin_subtest "Show message: json --body=true"
12 output=$(notmuch show --format=json --body=true "json-show-message")
13 test_expect_equal_json "$output" "[[[{\"id\": \"${gen_msg_id}\", \"match\": true, \"excluded\": false, \"filename\": [\"${gen_msg_filename}\"], \"timestamp\": 946728000, \"date_relative\": \"2000-01-01\", \"tags\": [\"inbox\",\"unread\"], \"headers\": {\"Subject\": \"json-show-subject\", \"From\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"To\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"Bcc\": \"test_suite+bcc@notmuchmail.org\", \"Reply-To\": \"test_suite+replyto@notmuchmail.org\", \"Date\": \"Sat, 01 Jan 2000 12:00:00 +0000\"}, \"body\": [{\"id\": 1, \"content-type\": \"text/plain\", \"content\": \"json-show-message\n\"}]}, []]]]"
14
15 test_begin_subtest "Show message: json --body=false"
16 output=$(notmuch show --format=json --body=false "json-show-message")
17 test_expect_equal_json "$output" "[[[{\"id\": \"${gen_msg_id}\", \"match\": true, \"excluded\": false, \"filename\": [\"${gen_msg_filename}\"], \"timestamp\": 946728000, \"date_relative\": \"2000-01-01\", \"tags\": [\"inbox\",\"unread\"], \"headers\": {\"Subject\": \"json-show-subject\", \"From\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"To\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"Bcc\": \"test_suite+bcc@notmuchmail.org\", \"Reply-To\": \"test_suite+replyto@notmuchmail.org\", \"Date\": \"Sat, 01 Jan 2000 12:00:00 +0000\"}}, []]]]"
18
19 test_begin_subtest "Search message: json"
20 add_message "[subject]=\"json-search-subject\"" "[date]=\"Sat, 01 Jan 2000 12:00:00 -0000\"" "[body]=\"json-search-message\""
21 output=$(notmuch search --format=json "json-search-message" | notmuch_search_sanitize)
22 test_expect_equal_json "$output" "[{\"thread\": \"XXX\",
23  \"timestamp\": 946728000,
24  \"date_relative\": \"2000-01-01\",
25  \"matched\": 1,
26  \"total\": 1,
27  \"authors\": \"Notmuch Test Suite\",
28  \"subject\": \"json-search-subject\",
29  \"query\": [\"id:$gen_msg_id\", null],
30  \"tags\": [\"inbox\",
31  \"unread\"]}]"
32
33 test_begin_subtest "Show message: json, utf-8"
34 add_message "[subject]=\"json-show-utf8-body-sübjéct\"" "[date]=\"Sat, 01 Jan 2000 12:00:00 -0000\"" "[body]=\"jsön-show-méssage\""
35 output=$(notmuch show --format=json "jsön-show-méssage")
36 test_expect_equal_json "$output" "[[[{\"id\": \"${gen_msg_id}\", \"match\": true, \"excluded\": false, \"filename\": [\"${gen_msg_filename}\"], \"timestamp\": 946728000, \"date_relative\": \"2000-01-01\", \"tags\": [\"inbox\",\"unread\"], \"headers\": {\"Subject\": \"json-show-utf8-body-sübjéct\", \"From\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"To\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"Date\": \"Sat, 01 Jan 2000 12:00:00 +0000\"}, \"body\": [{\"id\": 1, \"content-type\": \"text/plain\", \"content\": \"jsön-show-méssage\n\"}]}, []]]]"
37
38 test_begin_subtest "Show message: json, inline attachment filename"
39 subject='json-show-inline-attachment-filename'
40 id="json-show-inline-attachment-filename@notmuchmail.org"
41 emacs_fcc_message \
42     "$subject" \
43     'This is a test message with inline attachment with a filename' \
44     "(mml-attach-file \"$TEST_DIRECTORY/README\" nil nil \"inline\")
45      (message-goto-eoh)
46      (insert \"Message-ID: <$id>\n\")"
47 output=$(notmuch show --format=json "id:$id")
48 filename=$(notmuch search --output=files "id:$id")
49 # Get length of README after base64-encoding, minus additional newline.
50 attachment_length=$(( $(base64 $TEST_DIRECTORY/README | wc -c) - 1 ))
51 test_expect_equal_json "$output" "[[[{\"id\": \"$id\", \"match\": true, \"excluded\": false, \"filename\": [\"$filename\"], \"timestamp\": 946728000, \"date_relative\": \"2000-01-01\", \"tags\": [\"inbox\"], \"headers\": {\"Subject\": \"$subject\", \"From\": \"Notmuch Test Suite <test_suite@notmuchmail.org>\", \"To\": \"test_suite@notmuchmail.org\", \"Date\": \"Sat, 01 Jan 2000 12:00:00 +0000\"}, \"body\": [{\"id\": 1, \"content-type\": \"multipart/mixed\", \"content\": [{\"id\": 2, \"content-type\": \"text/plain\", \"content\": \"This is a test message with inline attachment with a filename\"}, {\"id\": 3, \"content-type\": \"application/octet-stream\", \"content-length\": $attachment_length, \"content-transfer-encoding\": \"base64\", \"content-disposition\": \"inline\", \"filename\": \"README\"}]}]}, []]]]"
52
53 test_begin_subtest "Search message: json, utf-8"
54 add_message "[subject]=\"json-search-utf8-body-sübjéct\"" "[date]=\"Sat, 01 Jan 2000 12:00:00 -0000\"" "[body]=\"jsön-search-méssage\""
55 output=$(notmuch search --format=json "jsön-search-méssage" | notmuch_search_sanitize)
56 test_expect_equal_json "$output" "[{\"thread\": \"XXX\",
57  \"timestamp\": 946728000,
58  \"date_relative\": \"2000-01-01\",
59  \"matched\": 1,
60  \"total\": 1,
61  \"authors\": \"Notmuch Test Suite\",
62  \"subject\": \"json-search-utf8-body-sübjéct\",
63  \"query\": [\"id:$gen_msg_id\", null],
64  \"tags\": [\"inbox\",
65  \"unread\"]}]"
66
67 test_begin_subtest "Format version: too low"
68 test_expect_code 20 "notmuch search --format-version=0 \\*"
69
70 test_begin_subtest "Format version: too high"
71 test_expect_code 21 "notmuch search --format-version=999 \\*"
72
73 test_begin_subtest "Show message: multiple filenames"
74 add_message "[id]=message-id@example.com [filename]=copy1"
75 add_message "[id]=message-id@example.com [filename]=copy2"
76 cat <<EOF > EXPECTED
77 [
78     [
79         [
80             {
81                 "date_relative": "2001-01-05",
82                 "excluded": false,
83                 "filename": [
84                     "${MAIL_DIR}/copy1",
85                     "${MAIL_DIR}/copy2"
86                 ],
87                 "headers": {
88                     "Date": "Fri, 05 Jan 2001 15:43:52 +0000",
89                     "From": "Notmuch Test Suite <test_suite@notmuchmail.org>",
90                     "Subject": "Show message: multiple filenames",
91                     "To": "Notmuch Test Suite <test_suite@notmuchmail.org>"
92                 },
93                 "id": "message-id@example.com",
94                 "match": true,
95                 "tags": [
96                     "inbox",
97                     "unread"
98                 ],
99                 "timestamp": 978709432
100             },
101             []
102         ]
103     ]
104 ]
105 EOF
106 output=$(notmuch show --format=json --body=false id:message-id@example.com)
107 test_expect_equal_json "$output" "$(cat EXPECTED)"
108
109 test_begin_subtest "Show message: multiple filenames, format version 2"
110 cat <<EOF > EXPECTED
111 [
112     [
113         [
114             {
115                 "date_relative": "2001-01-05",
116                 "excluded": false,
117                 "filename": "${MAIL_DIR}/copy1",
118                 "headers": {
119                     "Date": "Fri, 05 Jan 2001 15:43:52 +0000",
120                     "From": "Notmuch Test Suite <test_suite@notmuchmail.org>",
121                     "Subject": "Show message: multiple filenames",
122                     "To": "Notmuch Test Suite <test_suite@notmuchmail.org>"
123                 },
124                 "id": "message-id@example.com",
125                 "match": true,
126                 "tags": [
127                     "inbox",
128                     "unread"
129                 ],
130                 "timestamp": 978709432
131             },
132             []
133         ]
134     ]
135 ]
136 EOF
137 output=$(notmuch show --format=json --body=false --format-version=2 id:message-id@example.com)
138 test_expect_equal_json "$output" "$(cat EXPECTED)"
139
140 test_done