From ad2c6d285135524be2cbcce7b41cd91983fdff3c Mon Sep 17 00:00:00 2001 From: Prasanna Kumar Kalever Date: Wed, 1 Sep 2021 17:33:01 +0530 Subject: [PATCH] util: add gzip helper function Signed-off-by: Prasanna Kumar Kalever --- internal/util/log/log_utils.go | 52 +++++++++++++++++++++++++++++ internal/util/log/log_utils_test.go | 47 ++++++++++++++++++++++++++ 2 files changed, 99 insertions(+) create mode 100644 internal/util/log/log_utils.go create mode 100644 internal/util/log/log_utils_test.go diff --git a/internal/util/log/log_utils.go b/internal/util/log/log_utils.go new file mode 100644 index 000000000..18a778996 --- /dev/null +++ b/internal/util/log/log_utils.go @@ -0,0 +1,52 @@ +/* +Copyright 2021 The Ceph-CSI Authors. +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package log + +import ( + "compress/gzip" + "io/ioutil" + "os" + "strings" +) + +// GzipLogFile convert and replace log file from text format to gzip +// compressed format. +func GzipLogFile(pathToFile string) error { + // Get all the bytes from the file. + content, err := ioutil.ReadFile(pathToFile) // #nosec:G304, file inclusion via variable. + if err != nil { + return err + } + + // Replace .log extension with .gz extension. + newExt := strings.Replace(pathToFile, ".log", ".gz", -1) + + // Open file for writing. + gf, err := os.OpenFile(newExt, os.O_CREATE|os.O_RDWR|os.O_TRUNC, 0o644) // #nosec:G304,G302, file inclusion & perms + if err != nil { + return err + } + defer gf.Close() // #nosec:G307, error on close is not critical here + + // Write compressed data. + w := gzip.NewWriter(gf) + defer w.Close() + if _, err = w.Write(content); err != nil { + os.Remove(newExt) // #nosec:G104, not important error to handle + + return err + } + + return os.Remove(pathToFile) +} diff --git a/internal/util/log/log_utils_test.go b/internal/util/log/log_utils_test.go new file mode 100644 index 000000000..bd05fdfc1 --- /dev/null +++ b/internal/util/log/log_utils_test.go @@ -0,0 +1,47 @@ +/* +Copyright 2021 ceph-csi authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package log + +import ( + "errors" + "fmt" + "io/ioutil" + "os" + "strings" + "testing" +) + +func TestGzipLogFile(t *testing.T) { + t.Parallel() + tmpDir := t.TempDir() + logFile, err := ioutil.TempFile(tmpDir, "rbd-*.log") + if err != nil { + fmt.Println(err) + } + defer os.Remove(logFile.Name()) + + if err = GzipLogFile(logFile.Name()); err != nil { + t.Errorf("GzipLogFile failed: %v", err) + } + + newExt := strings.Replace(logFile.Name(), ".log", ".gz", -1) + if _, err = os.Stat(newExt); errors.Is(err, os.ErrNotExist) { + t.Errorf("compressed logFile (%s) not found: %v", newExt, err) + } + + os.Remove(newExt) +}