[PBCKP-198] Added tablespaces into show command output

- Solve Issue #431
- Output all tablespaces in backup in JSON output
- Output all tablespaces in backup in PLAIN output

Author: oleg gurev

src/show.c

@@ -67,6 +67,7 @@ static void show_archive_plain(const char *instance_name, uint32 xlog_seg_size,
 							   parray *timelines_list, bool show_name);
 static void show_archive_json(const char *instance_name, uint32 xlog_seg_size,
 							  parray *tli_list);
+static bool backup_has_tablespace_map(pgBackup *backup);
 
 static PQExpBufferData show_buf;
 static bool first_instance = true;
@@ -479,6 +480,32 @@ print_backup_json_object(PQExpBuffer buf, pgBackup *backup)
 		appendPQExpBuffer(buf, "%u", backup->content_crc);
 	}
 
+	/* print tablespaces list */
+	if (backup_has_tablespace_map(backup))
+	{
+		parray	   *links = parray_new();
+
+		json_add_key(buf, "tablespace_map", json_level);
+		json_add(buf, JT_BEGIN_ARRAY, &json_level);
+
+		read_tablespace_map(links, backup->root_dir);
+		parray_qsort(links, pgFileCompareLinked);
+
+		for (size_t i = 0; i < parray_num(links); i++){
+			pgFile	   *link = (pgFile *) parray_get(links, i);
+			if (i)
+				appendPQExpBufferChar(buf, ',');
+			json_add(buf, JT_BEGIN_OBJECT, &json_level);
+			json_add_value(buf, "oid", link->name, json_level, true);
+			json_add_value(buf, "path", link->linked, json_level, true);
+			json_add(buf, JT_END_OBJECT, &json_level);
+		}
+		/* End of tablespaces */
+		json_add(buf, JT_END_ARRAY, &json_level);
+		parray_walk(links, pgFileFree);
+		parray_free(links);
+	}
+
 	json_add(buf, JT_END_OBJECT, &json_level);
 }
 
@@ -521,7 +548,27 @@ show_backup(InstanceState *instanceState, time_t requested_backup_id)
 	}
 
 	if (show_format == SHOW_PLAIN)
+	{
 		pgBackupWriteControl(stdout, backup, false);
+
+		/* print tablespaces list */
+		if (backup_has_tablespace_map(backup))
+		{
+			parray	   *links = parray_new();
+
+			fio_fprintf(stdout, "\ntablespace_map = '");
+
+			read_tablespace_map(links, backup->root_dir);
+			parray_qsort(links, pgFileCompareLinked);
+
+			for (size_t i = 0; i < parray_num(links); i++){
+				pgFile	   *link = (pgFile *) parray_get(links, i);
+				fio_fprintf(stdout, "%s %s%s", link->name, link->linked, (i < parray_num(links) - 1) ? "; " : "'\n");
+			}
+			parray_walk(links, pgFileFree);
+			parray_free(links);
+		}
+	}
 	else
 		elog(ERROR, "Invalid show format %d", (int) show_format);
 
@@ -1174,3 +1221,10 @@ show_archive_json(const char *instance_name, uint32 xlog_seg_size,
 
 	first_instance = false;
 }
+
+static bool backup_has_tablespace_map(pgBackup *backup)
+{
+		char        map_path[MAXPGPATH];
+		join_path_components(map_path, backup->database_dir, PG_TABLESPACE_MAP_FILE);
+		return fileExists(map_path, FIO_BACKUP_HOST);
+}

tests/show_test.py

@@ -507,3 +507,39 @@ def test_color_with_no_terminal(self):
                 '[0m', e.message,
                 '\n Unexpected Error Message: {0}\n CMD: {1}'.format(
                     repr(e.message), self.cmd))
+
+    # @unittest.skip("skip")
+    def test_tablespace_print_issue_431(self):
+        backup_dir = os.path.join(self.tmp_path, self.module_name, self.fname, 'backup')
+        node = self.make_simple_node(
+            base_dir=os.path.join(self.module_name, self.fname, 'node'),
+            initdb_params=['--data-checksums'])
+
+        self.init_pb(backup_dir)
+        self.add_instance(backup_dir, 'node', node)
+        self.set_archiving(backup_dir, 'node', node)
+        node.slow_start()
+
+        # Create tablespace
+        tblspc_path = os.path.join(node.base_dir, "tblspc")
+        os.makedirs(tblspc_path)
+        with node.connect("postgres") as con:
+            con.connection.autocommit = True
+            con.execute("CREATE TABLESPACE tblspc LOCATION '%s'" % tblspc_path)
+            con.connection.autocommit = False
+            con.execute("CREATE TABLE test (id int) TABLESPACE tblspc")
+            con.execute("INSERT INTO test VALUES (1)")
+            con.commit()
+
+        full_backup_id =  self.backup_node(backup_dir, 'node', node)
+        self.assertIn("OK", self.show_pb(backup_dir,'node', as_text=True))
+        # Check that tablespace info exists. JSON
+        self.assertIn("tablespace_map", self.show_pb(backup_dir, 'node', as_text=True))
+        self.assertIn("oid", self.show_pb(backup_dir, 'node', as_text=True))
+        self.assertIn("path", self.show_pb(backup_dir, 'node', as_text=True))
+        self.assertIn(tblspc_path, self.show_pb(backup_dir, 'node', as_text=True))
+        # Check that tablespace info exists. PLAIN
+        self.assertIn("tablespace_map", self.show_pb(backup_dir, 'node', backup_id=full_backup_id, as_text=True, as_json=False))
+        self.assertIn(tblspc_path, self.show_pb(backup_dir, 'node', backup_id=full_backup_id, as_text=True, as_json=False))
+        # Check that tablespace info NOT exists if backup id not provided. PLAIN
+        self.assertNotIn("tablespace_map", self.show_pb(backup_dir, 'node', as_text=True, as_json=False))