Repository: ceph/go-ceph
Pull request #377 (2020-10-04 15:37:03)

cephfs admin: add ListFileSystems function for listing fs with pools
For users who need to know the pools (by name) as well as the files
systems, we add ListFileSystems which is similar to 'ceph fs ls', rather
than the existing ListVolumes as that function is simlar to 'ceph fs
volume ls' and that does not return pool information.

Fixes: #375

## Checklist
- [x] Added tests for features and functional changes
- [x] Public functions and types are documented
- [x] Standard formatting is applied to Go code



Patch:
diff --git a/cephfs/admin/volume.go b/cephfs/admin/volume.go
index 0e7ccf5..082fa4d 100644
--- a/cephfs/admin/volume.go
+++ b/cephfs/admin/volume.go
@@ -9,6 +9,7 @@ import (
 var (
 	listVolumesCmd = []byte(`{"prefix":"fs volume ls"}`)
 	dumpVolumesCmd = []byte(`{"prefix":"fs dump","format":"json"}`)
+	listFsCmd      = []byte(`{"prefix":"fs ls","format":"json"}`)
 )
 
 // ListVolumes return a list of volumes in this Ceph cluster.
@@ -20,6 +21,34 @@ func (fsa *FSAdmin) ListVolumes() ([]string, error) {
 	return parseListNames(res)
 }
 
+// FSPoolInfo contains the name of a file system as well as the metadata and
+// data pools. Pool information is available by ID or by name.
+type FSPoolInfo struct {
+	Name           string   `json:"name"`
+	MetadataPool   string   `json:"metadata_pool"`
+	MetadataPoolID int      `json:"metadata_pool_id"`
+	DataPools      []string `json:"data_pools"`
+	DataPoolIDs    []int    `json:"data_pool_ids"`
+}
+
+// ListFileSystems lists file systems along with the pools occupied by those
+// file systems.
+//
+// Similar To:
+//  ceph fs ls
+func (fsa *FSAdmin) ListFileSystems() ([]FSPoolInfo, error) {
+	res := fsa.rawMonCommand(listFsCmd)
+	return parseFsList(res)
+}
+
+func parseFsList(res response) ([]FSPoolInfo, error) {
+	var listing []FSPoolInfo
+	if err := res.noStatus().unmarshal(&listing).End(); err != nil {
+		return nil, err
+	}
+	return listing, nil
+}
+
 // VolumeIdent contains a pair of file system identifying values: the volume
 // name and the volume ID.
 type VolumeIdent struct {


Test patch:
diff --git a/cephfs/admin/volume_test.go b/cephfs/admin/volume_test.go
index 0a1155c..3e1edf9 100644
--- a/cephfs/admin/volume_test.go
+++ b/cephfs/admin/volume_test.go
@@ -262,3 +262,115 @@ func TestParseVolumeStatus(t *testing.T) {
 	})
 
 }
+
+var sampleFsLs1 = []byte(`
+[
+  {
+    "name": "cephfs",
+    "metadata_pool": "cephfs_metadata",
+    "metadata_pool_id": 2,
+    "data_pool_ids": [
+      1
+    ],
+    "data_pools": [
+      "cephfs_data"
+    ]
+  }
+]
+`)
+
+var sampleFsLs2 = []byte(`
+[
+  {
+    "name": "cephfs",
+    "metadata_pool": "cephfs_metadata",
+    "metadata_pool_id": 2,
+    "data_pool_ids": [
+      1
+    ],
+    "data_pools": [
+      "cephfs_data"
+    ]
+  },
+  {
+    "name": "archivefs",
+    "metadata_pool": "archivefs_metadata",
+    "metadata_pool_id": 6,
+    "data_pool_ids": [
+      4,
+      5
+    ],
+    "data_pools": [
+      "archivefs_data1",
+      "archivefs_data2"
+    ]
+  }
+]
+`)
+
+func TestParseFsList(t *testing.T) {
+	t.Run("error", func(t *testing.T) {
+		_, err := parseFsList(response{err: errors.New("eek")})
+		assert.Error(t, err)
+		assert.Equal(t, "eek", err.Error())
+	})
+	t.Run("statusSet", func(t *testing.T) {
+		_, err := parseFsList(response{status: "oof"})
+		assert.Error(t, err)
+	})
+	t.Run("badJSON", func(t *testing.T) {
+		_, err := parseFsList(response{body: []byte("______")})
+		assert.Error(t, err)
+	})
+	t.Run("ok1", func(t *testing.T) {
+		l, err := parseFsList(response{body: sampleFsLs1})
+		assert.NoError(t, err)
+		if assert.NotNil(t, l) && assert.Len(t, l, 1) {
+			fs := l[0]
+			assert.Equal(t, "cephfs", fs.Name)
+			assert.Equal(t, "cephfs_metadata", fs.MetadataPool)
+			assert.Equal(t, 2, fs.MetadataPoolID)
+			assert.Len(t, fs.DataPools, 1)
+			assert.Contains(t, fs.DataPools, "cephfs_data")
+			assert.Len(t, fs.DataPoolIDs, 1)
+			assert.Contains(t, fs.DataPoolIDs, 1)
+		}
+	})
+	t.Run("ok2", func(t *testing.T) {
+		l, err := parseFsList(response{body: sampleFsLs2})
+		assert.NoError(t, err)
+		if assert.NotNil(t, l) && assert.Len(t, l, 2) {
+			fs := l[0]
+			assert.Equal(t, "cephfs", fs.Name)
+			assert.Equal(t, "cephfs_metadata", fs.MetadataPool)
+			assert.Equal(t, 2, fs.MetadataPoolID)
+			assert.Len(t, fs.DataPools, 1)
+			assert.Contains(t, fs.DataPools, "cephfs_data")
+			assert.Len(t, fs.DataPoolIDs, 1)
+			assert.Contains(t, fs.DataPoolIDs, 1)
+			fs = l[1]
+			assert.Equal(t, "archivefs", fs.Name)
+			assert.Equal(t, "archivefs_metadata", fs.MetadataPool)
+			assert.Equal(t, 6, fs.MetadataPoolID)
+			assert.Len(t, fs.DataPools, 2)
+			assert.Contains(t, fs.DataPools, "archivefs_data1")
+			assert.Contains(t, fs.DataPools, "archivefs_data2")
+			assert.Len(t, fs.DataPoolIDs, 2)
+			assert.Contains(t, fs.DataPoolIDs, 4)
+			assert.Contains(t, fs.DataPoolIDs, 5)
+		}
+	})
+}
+
+func TestListFileSystems(t *testing.T) {
+	fsa := getFSAdmin(t)
+
+	l, err := fsa.ListFileSystems()
+	assert.NoError(t, err)
+	if assert.Len(t, l, 1) {
+		assert.Equal(t, "cephfs", l[0].Name)
+		assert.Equal(t, "cephfs_metadata", l[0].MetadataPool)
+		assert.Len(t, l[0].DataPools, 1)
+		assert.Contains(t, l[0].DataPools, "cephfs_data")
+	}
+}