golang parse df -h output hard way

golang df code

字数统计: 546阅读时长: 2 min

 2021/12/05 

背景

最近有个场景，需要解析远程调用命令df -h，输出的格式类似CentOS下的输出:

# df -h
Filesystem      Size  Used Avail Use% Mounted on
/dev/vda1        99G  5.5G   89G   6% /
devtmpfs        3.8G     0  3.8G   0% /dev
tmpfs           3.8G   24K  3.8G   1% /dev/shm
tmpfs           3.8G  274M  3.6G   8% /run
tmpfs           3.8G     0  3.8G   0% /sys/fs/cgroup
tmpfs           778M     0  778M   0% /run/user/0
/dev/vdb        296G  485M  280G   1% /data

其中 -h的意思是：

-h, –human-readable print sizes in powers of 1024 (e.g. 1023M)

输出中各列的含义:

Filesystem：文件系统名，可解理为分区，包含物理和虚拟分区。
- 其中dev表示device，即挂载的真实物理磁盘。
- tmpfs为系统进程比如/run运行的临时分区。
Size：分区大小
Used：已使用容量
Avail：还可以使用的容量
Use%：已用百分比
Mounted on：挂载点（目录或路径）

代码片段

package df

import (
	"fmt"
	"reflect"
	"strings"
)

type commandOutputdrowIdx int

const (
	command_output_row_idx_file_system commandOutputdrowIdx = iota
	command_output_row_idx_size
	command_output_row_idx_used
	command_output_row_idx_available
	command_output_row_idx_used_percent
	command_output_row_idx_mounted_on
)

// headers is the headers in 'df -h' output.
var headers = []string{
	"Filesystem",
	"Size",
	"Used",
	"Avail",
	"Use%",
	// Mounted on
	"Mounted",
	"on",
}

// Parse parses 'df -h' command output and returns the rows.
func Parse(output string) ([]Row, error) {
	lines := strings.Split(output, "\n")
	rows := make([]Row, 0, len(lines))
	headerFound := false
	for _, line := range lines {
		if len(line) == 0 {
			continue
		}

		ds := strings.Fields(strings.TrimSpace(line))
		if ds[0] == headers[0] {
			if !reflect.DeepEqual(ds, headers) {
				return nil, fmt.Errorf(`unexpected 'df -h' command header order (%v, expected %v, output: %q)`, ds, headers, output)
			}
			headerFound = true
			continue
		}

		if !headerFound {
			continue
		}

		row, err := parseRow(ds)
		if err != nil {
			return nil, err
		}

		rows = append(rows, row)
	}

	return rows, nil
}

func parseRow(row []string) (Row, error) {
	if len(row) != len(headers)-1 {
		return Row{}, fmt.Errorf(`unexpected row column number %v (expected %v)`, row, headers)
	}

	return Row{
		Filesystem: strings.TrimSpace(row[command_output_row_idx_file_system]),
		Size:       strings.TrimSpace(row[command_output_row_idx_size]),
		Used:       strings.TrimSpace(row[command_output_row_idx_used]),
		Avail:      strings.TrimSpace(row[command_output_row_idx_available]),
		UsePercent: strings.TrimSpace(strings.Replace(row[command_output_row_idx_used_percent], "%", " %", -1)),
		MountedOn:  strings.TrimSpace(row[command_output_row_idx_mounted_on]),
	}, nil
}