Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(lvm): continue refactoring of lvm command calling convention #261

Merged
merged 2 commits into from
Oct 18, 2023
Merged

refactor(lvm): continue refactoring of lvm command calling convention #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9fe265
refactor(ci): rename env variables and update vgcreate command
kro-cat Oct 8, 2023
97dd9c5
refactor(lvm): update all lvm commands to use split output
kro-cat Oct 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ci/ci-test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ then
export KUBECONFIG="${HOME}/.kube/config"
fi

# systemid for the testing environment. The kubernetes host machine will serve as the foreign lvm system.
LVM_SYSTEMID="openebs-ci-test-system"
LVM_CONFIG="global{system_id_source=lvmlocal}local{system_id=${LVM_SYSTEMID}}"
# foreign systemid for the testing environment.
FOREIGN_LVM_SYSTEMID="openebs-ci-test-system"
FOREIGN_LVM_CONFIG="global{system_id_source=lvmlocal}local{system_id=${FOREIGN_LVM_SYSTEMID}}"

# Clean up generated resources for successive tests.
cleanup_loopdev() {
Expand All @@ -54,7 +54,7 @@ cleanup_lvmvg() {
cleanup_foreign_lvmvg() {
if [ -f /tmp/openebs_ci_foreign_disk.img ]
then
sudo vgremove foreign_lvmvg --config="${LVM_CONFIG}" -y || true
sudo vgremove foreign_lvmvg --config="${FOREIGN_LVM_CONFIG}" -y || true
rm /tmp/openebs_ci_foreign_disk.img
fi
cleanup_loopdev
Expand Down Expand Up @@ -91,7 +91,7 @@ cleanup_foreign_lvmvg
truncate -s 1024G /tmp/openebs_ci_foreign_disk.img
foreign_disk="$(sudo losetup -f /tmp/openebs_ci_foreign_disk.img --show)"
sudo pvcreate "${foreign_disk}"
sudo vgcreate foreign_lvmvg "${foreign_disk}" --systemid="${LVM_SYSTEMID}"
sudo vgcreate foreign_lvmvg "${foreign_disk}" --config="${FOREIGN_LVM_CONFIG}"

# install snapshot and thin volume module for lvm
sudo modprobe dm-snapshot
Expand Down
82 changes: 37 additions & 45 deletions pkg/lvm/lvm_util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,27 @@ func buildLVMDestroyArgs(vol *apis.LVMVolume) []string {
return LVMVolArg
}

// RunCommandSplit is a wrapper function to run a command and receive its
// STDERR and STDOUT streams in separate []byte vars.
func RunCommandSplit(command string, args ...string) ([]byte, []byte, error) {
var cmdStdout bytes.Buffer
var cmdStderr bytes.Buffer

cmd := exec.Command(command, args...)
cmd.Stdout = &cmdStdout
cmd.Stderr = &cmdStderr
err := cmd.Run()

output := cmdStdout.Bytes()
error_output := cmdStderr.Bytes()

if len(error_output) > 0 {
klog.Warningf("lvm: said into stderr: %s", error_output)
}

return output, error_output, err
}

// CreateVolume creates the lvm volume
func CreateVolume(vol *apis.LVMVolume) error {
volume := vol.Spec.VolGroup + "/" + vol.Name
Expand All @@ -275,8 +296,7 @@ func CreateVolume(vol *apis.LVMVolume) error {
}

args := buildLVMCreateArgs(vol)
cmd := exec.Command(LVCreate, args...)
out, err := cmd.CombinedOutput()
out, _, err := RunCommandSplit(LVCreate, args...)

if err != nil {
err = newExecError(out, err)
Expand Down Expand Up @@ -314,8 +334,7 @@ func DestroyVolume(vol *apis.LVMVolume) error {
}

args := buildLVMDestroyArgs(vol)
cmd := exec.Command(LVRemove, args...)
out, err := cmd.CombinedOutput()
out, _, err := RunCommandSplit(LVRemove, args...)

if err != nil {
klog.Errorf(
Expand Down Expand Up @@ -406,8 +425,7 @@ func ResizeLVMVolume(vol *apis.LVMVolume, resizefs bool) error {
volume := vol.Spec.VolGroup + "/" + vol.Name

args := buildVolumeResizeArgs(vol, resizefs)
cmd := exec.Command(LVExtend, args...)
out, err := cmd.CombinedOutput()
out, _, err := RunCommandSplit(LVExtend, args...)

if err != nil {
klog.Errorf(
Expand All @@ -430,8 +448,7 @@ func getLVSize(vol *apis.LVMVolume) (uint64, error) {
"--nosuffix",
}

cmd := exec.Command(LVList, args...)
raw, err := cmd.CombinedOutput()
raw, _, err := RunCommandSplit(LVList, args...)
if err != nil {
return 0, errors.Wrapf(
err,
Expand Down Expand Up @@ -495,8 +512,7 @@ func CreateSnapshot(snap *apis.LVMSnapshot) error {
snapVolume := snap.Spec.VolGroup + "/" + getLVMSnapName(snap.Name)

args := buildLVMSnapCreateArgs(snap)
cmd := exec.Command(LVCreate, args...)
out, err := cmd.CombinedOutput()
out, _, err := RunCommandSplit(LVCreate, args...)

if err != nil {
klog.Errorf("lvm: could not create snapshot %s cmd %v error: %s", snapVolume, args, string(out))
Expand Down Expand Up @@ -524,8 +540,7 @@ func DestroySnapshot(snap *apis.LVMSnapshot) error {
}

args := buildLVMSnapDestroyArgs(snap)
cmd := exec.Command(LVRemove, args...)
out, err := cmd.CombinedOutput()
out, _, err := RunCommandSplit(LVRemove, args...)

if err != nil {
klog.Errorf("lvm: could not remove snapshot %s cmd %v error: %s", snapVolume, args, string(out))
Expand Down Expand Up @@ -639,34 +654,13 @@ func getIntFieldValue(fieldName, fieldValue string) int {
// serving vgs or other lvm utility.
func ReloadLVMMetadataCache() error {
args := []string{"--cache"}
cmd := exec.Command(PVScan, args...)
output, err := cmd.CombinedOutput()
output, _, err := RunCommandSplit(PVScan, args...)
if err != nil {
klog.Errorf("lvm: reload lvm metadata cache: %v - %v", string(output), err)
return err
}
return nil
}

// RunCommandSplit is a wrapper function to run a command and receive its
// STDERR and STDOUT streams in separate []byte vars.
func RunCommandSplit(command string, args ...string) ([]byte, []byte, error) {
var cmdStdout bytes.Buffer
var cmdStderr bytes.Buffer

cmd := exec.Command(command, args...)
cmd.Stdout = &cmdStdout
cmd.Stderr = &cmdStderr
err := cmd.Run()

output := cmdStdout.Bytes()
error_output := cmdStderr.Bytes()

if len(error_output) > 0 {
klog.Warningf("lvm: said into stderr: %s", error_output)
}

return output, error_output, err
return nil
}

// ListLVMVolumeGroup invokes `vgs` to list all the available volume
Expand Down Expand Up @@ -880,12 +874,12 @@ func ListLVMLogicalVolume() ([]LogicalVolume, error) {
"--reportformat", "json",
"--units", "b",
}
cmd := exec.Command(LVList, args...)
output, err := cmd.CombinedOutput()
output, _, err := RunCommandSplit(LVList, args...)
if err != nil {
klog.Errorf("lvm: error while running command %s %v: %v", LVList, args, err)
return nil, err
}

return decodeLvsJSON(output)
}

Expand All @@ -902,12 +896,12 @@ func ListLVMPhysicalVolume() ([]PhysicalVolume, error) {
"--reportformat", "json",
"--units", "b",
}
cmd := exec.Command(PVList, args...)
output, err := cmd.CombinedOutput()
output, _, err := RunCommandSplit(PVList, args...)
if err != nil {
klog.Errorf("lvm: error while running command %s %v: %v", PVList, args, err)
return nil, err
}

return decodePvsJSON(output)
}

Expand Down Expand Up @@ -1029,20 +1023,19 @@ func decodePvsJSON(raw []byte) ([]PhysicalVolume, error) {

// lvThinExists verifies if thin pool/volume already exists for given volumegroup
func lvThinExists(vg string, name string) bool {
cmd := exec.Command("lvs", vg+"/"+name, "--noheadings", "-o", "lv_name")
out, err := cmd.CombinedOutput()
out, _, err := RunCommandSplit("lvs", vg+"/"+name, "--noheadings", "-o", "lv_name")
if err != nil {
klog.Errorf("failed to list existing volumes:%v", err)
return false
}

return name == strings.TrimSpace(string(out))
}

// snapshotExists checks if a snapshot volume exists for the given volumegroup
// and snapshot name.
func isSnapshotExists(vg, snapVolumeName string) (bool, error) {
cmd := exec.Command("lvs", vg+"/"+snapVolumeName, "--noheadings", "-o", "lv_name")
out, err := cmd.CombinedOutput()
out, _, err := RunCommandSplit("lvs", vg+"/"+snapVolumeName, "--noheadings", "-o", "lv_name")
if err != nil {
return false, err
}
Expand All @@ -1051,8 +1044,7 @@ func isSnapshotExists(vg, snapVolumeName string) (bool, error) {

// getVGSize get the size in bytes for given volumegroup name
func getVGSize(vgname string) string {
cmd := exec.Command("vgs", vgname, "--noheadings", "-o", "vg_free", "--units", "b", "--nosuffix")
out, err := cmd.CombinedOutput()
out, _, err := RunCommandSplit("vgs", vgname, "--noheadings", "-o", "vg_free", "--units", "b", "--nosuffix")
if err != nil {
klog.Errorf("failed to list existing volumegroup:%v , %v", vgname, err)
return ""
Expand Down