From 1aa9c1a18ff53ecbdc320ae68ee0d65507b943d5 Mon Sep 17 00:00:00 2001
From: "Masih H. Derkani" <m@derkani.org>
Date: Tue, 20 Jul 2021 12:14:20 +0100
Subject: [PATCH] Add test with expected failure for #3503

Write a `sharness` test that expects failure documenting the issue
raised in #3503. The issue may get resolved in the refactoring of
`ipfs dag get` command to support go-ipld-prime (e.g. #8171). For now
add a `sharness` test that expects failure. We will then flip the
expectation in the success in the rewriting PR to check if #3503 gets
resolved.

Relates to:
- https://github.com/ipfs/go-ipfs/issues/3503
---
 test/sharness/t0055-dag-put-json-new-line.sh | 40 ++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100755 test/sharness/t0055-dag-put-json-new-line.sh

diff --git a/test/sharness/t0055-dag-put-json-new-line.sh b/test/sharness/t0055-dag-put-json-new-line.sh
new file mode 100755
index 00000000000..92ae648ddae
--- /dev/null
+++ b/test/sharness/t0055-dag-put-json-new-line.sh
@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+test_description='Test retrieval of JSON put as CBOR does not end with new-line'
+
+. lib/test-lib.sh
+
+test_init_ipfs
+
+test_expect_success 'create test JSON files' '
+  WANT_JSON="{\"data\":1234}"
+  WANT_HASH="bafyreidcqah6v3py3ujdc3ris22rjlfntaw7ajrus2f2477kpnizulaoea"
+  printf "${WANT_JSON}\n" > with_newline.json &&
+  printf "${WANT_JSON}" > without_newline.json
+'
+
+test_expect_success 'puts as CBOR work' '
+  GOT_HASH_WITHOUT_NEWLINE="$(cat without_newline.json | ipfs dag put -f cbor)"
+  GOT_HASH_WITH_NEWLINE="$(cat with_newline.json | ipfs dag put -f cbor)"
+'
+
+test_expect_success 'put hashes with or without newline are equal' '
+  test "${GOT_HASH_WITH_NEWLINE}" = "${GOT_HASH_WITHOUT_NEWLINE}"
+'
+
+test_expect_success 'hashes are of expected value' '
+  test "${WANT_HASH}" = "${GOT_HASH_WITH_NEWLINE}"
+  test "${WANT_HASH}" = "${GOT_HASH_WITHOUT_NEWLINE}"
+'
+
+# Retrieval must not contain a new-line regardless of input JSON, because
+# objects are put using the stable CBOR format.
+# despite this, dag retrieval returns JSON with new-line.
+# Expect failure until fixed, as per:
+# - https://github.com/ipfs/go-ipfs/issues/3503#issuecomment-877295280
+test_expect_failure "retrieval by hash does not have new line" '
+  ipfs dag get "${WANT_HASH}" > got.json
+  test_cmp without_newline.json got.json
+'
+
+test_done