Refactor create and download commands

Author: Alvaro Muñoz

cmd/create.go

@@ -1,48 +1,48 @@
 package cmd
 
 import (
-  "log"
 	"fmt"
-  "path/filepath"
-  "os/exec"
-  "os"
+	"log"
+	"os"
+	"os/exec"
+	"path/filepath"
 
-  "github.com/spf13/cobra"
+	"github.com/spf13/cobra"
 )
 
 var createCmd = &cobra.Command{
-    Use:   "create",
-    Short: "Extracts a CodeQL database from a source path",
-    Long:  `Extracts a CodeQL database from a source path. Pass the CodeQL arguments after a '--' separator.
+	Use:   "create",
+	Short: "Extracts a CodeQL database from a source path",
+	Long: `Extracts a CodeQL database from a source path. Pass the CodeQL arguments after a '--' separator.
 
 eg: gh-qldb create --nwo foo/bar -- -s /path/to/src -l javascript`,
-    Run: func(cmd *cobra.Command, args []string) {
-      // --nwo foo/bar -- -s /path/to/src -l javascript
-      create(nwoFlag, args)
-    },
-  }
+	Run: func(cmd *cobra.Command, args []string) {
+		// --nwo foo/bar -- -s /path/to/src -l javascript
+		create(nwoFlag, args)
+	},
+}
 
 func init() {
-  rootCmd.AddCommand(createCmd)
-  createCmd.Flags().StringVarP(&nwoFlag, "nwo", "n", "", "The NWO of the repository to create the database for. If omitted, it will be inferred from git remotes.")
+	rootCmd.AddCommand(createCmd)
+	createCmd.Flags().StringVarP(&nwoFlag, "nwo", "n", "", "The NWO of the repository to create the database for. If omitted, it will be inferred from git remotes.")
 }
 
 func create(nwo string, codeqlArgs []string) {
 	fmt.Printf("Creating DB for '%s'. CodeQL args: '%v'", nwo, codeqlArgs)
-  destPath := filepath.Join(os.TempDir(), "codeql-db")
-  if err := os.MkdirAll(destPath, 0755); err != nil {
-			log.Fatal(err)
-  }
-  args := []string{"database", "create"}
-  args = append(args, codeqlArgs...)
-  args = append(args, "--") 
-  args = append(args, destPath) 
+	destPath := filepath.Join(os.TempDir(), "codeql-db")
+	if err := os.MkdirAll(destPath, 0755); err != nil {
+		log.Fatal(err)
+	}
+	args := []string{"database", "create"}
+	args = append(args, codeqlArgs...)
+	args = append(args, "--")
+	args = append(args, destPath)
 	cmd := exec.Command("codeql", args...)
 	cmd.Env = os.Environ()
 	_, err := cmd.CombinedOutput()
 	if err != nil {
 		log.Fatalln(err)
 	}
 
-  install(nwo, destPath, true)
+	install(nwo, destPath, true)
 }

cmd/download.go

@@ -3,32 +3,32 @@ package cmd
 import (
 	"errors"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"log"
 	"os"
 	"path/filepath"
 
+	"github.com/GitHubSecurityLab/gh-qldb/utils"
 	"github.com/cli/go-gh"
 	"github.com/cli/go-gh/pkg/api"
-  "github.com/spf13/cobra"
-  "github.com/GitHubSecurityLab/gh-qldb/utils"
+	"github.com/spf13/cobra"
 )
 
 var downloadCmd = &cobra.Command{
-    Use:   "download",
-    Short: "Downloads a CodeQL database from GitHub Code Scanning",
-    Long:  `Downloads a CodeQL database from GitHub Code Scanning`,
-    Run: func(cmd *cobra.Command, args []string) {
-      download()
-    },
-  }
+	Use:   "download",
+	Short: "Downloads a CodeQL database from GitHub Code Scanning",
+	Long:  `Downloads a CodeQL database from GitHub Code Scanning`,
+	Run: func(cmd *cobra.Command, args []string) {
+		download()
+	},
+}
 
 func init() {
-  rootCmd.AddCommand(downloadCmd)
-  downloadCmd.Flags().StringVarP(&nwoFlag, "nwo", "n", "", "The NWO of the repository to download the database for.")
-  downloadCmd.Flags().StringVarP(&languageFlag, "language", "l", "", "The primary language you want the database for.")
-  downloadCmd.MarkFlagRequired("nwo")
-  downloadCmd.MarkFlagRequired("language")
+	rootCmd.AddCommand(downloadCmd)
+	downloadCmd.Flags().StringVarP(&nwoFlag, "nwo", "n", "", "The NWO of the repository to download the database for.")
+	downloadCmd.Flags().StringVarP(&languageFlag, "language", "l", "", "The primary language you want the database for.")
+	downloadCmd.MarkFlagRequired("nwo")
+	downloadCmd.MarkFlagRequired("language")
 
 }
 
@@ -77,7 +77,7 @@ func download() {
 		}
 		defer resp.Body.Close()
 
-		body, err := ioutil.ReadAll(resp.Body)
+		body, err := io.ReadAll(resp.Body)
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -103,7 +103,7 @@ func download() {
 		// create file if not exists
 		if _, err := os.Stat(path); errors.Is(err, os.ErrNotExist) {
 			// write the DB to disk
-			err = ioutil.WriteFile(path, body, 0755)
+			err = os.WriteFile(path, body, 0755)
 			if err != nil {
 				log.Fatal(err)
 			}
@@ -116,4 +116,3 @@ func download() {
 	}
 	fmt.Println("Done")
 }
-

cmd/info.go

@@ -3,11 +3,12 @@ package cmd
 import (
 	"encoding/json"
 	"fmt"
-	"github.com/GitHubSecurityLab/gh-qldb/utils"
-	"github.com/spf13/cobra"
-	"io/ioutil"
 	"log"
+	"os"
 	"path/filepath"
+
+	"github.com/GitHubSecurityLab/gh-qldb/utils"
+	"github.com/spf13/cobra"
 )
 
 var infoCmd = &cobra.Command{
@@ -30,7 +31,7 @@ func init() {
 
 func info(nwo string, language string) {
 	dir := filepath.Join(utils.GetPath(nwo), language)
-	files, err := ioutil.ReadDir(dir)
+	files, err := os.ReadDir(dir)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -56,7 +57,7 @@ func info(nwo string, language string) {
 		fmt.Printf("%s", jsonStr)
 	} else {
 		for _, path := range pathList {
-			fmt.Printf("%s (%s)", path["path"], path["committedDate"])
+			fmt.Println(path["path"])
 		}
 	}
 }

utils/utils.go

@@ -1,36 +1,39 @@
 package utils
 
 import (
-	"os/exec"
-  "io"
+	"archive/zip"
+	"bytes"
 	"encoding/json"
-  "errors"
+	"errors"
+	"fmt"
+	"io"
+	"log"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"strings"
+
 	"gopkg.in/yaml.v3"
-  "os"
-  "path/filepath"
-  "strings"
-  "archive/zip"
-  "bytes"
-  "fmt"
-  "io/ioutil"
-  "log"
 
-	graphql "github.com/shurcooL/githubv4"
 	"github.com/cli/go-gh"
+	graphql "github.com/shurcooL/githubv4"
 )
 
 const (
 	ROOT = "codeql-dbs"
 	VCS  = "github.com"
 )
 
-func GetPath(nwo string) string {
+func GetBasePath() string {
 	home := os.Getenv("HOME")
-	return filepath.Join(home, ROOT, VCS, nwo)
+	return filepath.Join(home, ROOT, VCS)
+}
+
+func GetPath(nwo string) string {
+	return filepath.Join(GetBasePath(), nwo)
 }
 
 func ValidateDB(dbPath string) error {
-	fmt.Printf("Validating %s DB\n", dbPath)
 	cmd := exec.Command("codeql", "resolve", "database", dbPath)
 	cmd.Env = os.Environ()
 	jsonBytes, err := cmd.CombinedOutput()
@@ -58,7 +61,7 @@ func ExtractDBInfo(body []byte) (string, string, error) {
 				log.Fatal(err)
 			}
 			defer f.Close()
-			yamlBytes, err := ioutil.ReadAll(f)
+			yamlBytes, err := io.ReadAll(f)
 			if err != nil {
 				log.Fatal(err)
 			}
@@ -217,7 +220,7 @@ func GetCommitInfo(nwo string, commitSha string) (string, string, error) {
 
 	graphqlClient, err := gh.GQLClient(nil)
 	if err != nil {
-    return "", "", err
+		return "", "", err
 	}
 	var query struct {
 		Repository struct {
@@ -237,7 +240,7 @@ func GetCommitInfo(nwo string, commitSha string) (string, string, error) {
 	}
 	err = graphqlClient.Query("CommitInfo", &query, variables)
 	if err != nil {
-    return "", "", err
+		return "", "", err
 	}
-  return string(query.Repository.Object.Commit.AbbreviatedOid) , query.Repository.Object.Commit.CommittedDate.Format("2006-01-02T15:04:05"), nil
+	return string(query.Repository.Object.Commit.AbbreviatedOid), query.Repository.Object.Commit.CommittedDate.Format("2006-01-02T15:04:05"), nil
 }