Merge pull request #9 from netvolart/doc

Refactor

Readme.md

@@ -5,8 +5,25 @@ Currently we are supporting GitLab and Community Registry as a terraform modules
 
 ## Installation
 
+### MacOS via homebrew
+
+```bash
+brew tap netvolart/tap
+brew install joven
+```
+### Linux and MacOS from binary
+
 To install Joven, you can download the latest release from the [Releases](https://github.com/yourusername/joven/releases) page. Choose the binary that matches your operating system and architecture, download it, and place it in your system's PATH.
 
+For example:
+
+```sh
+wget https://github.com/netvolart/joven/releases/download/v0.0.1/joven_0.0.1_linux_amd64.tar.gz
+tar -xvzf joven_0.0.1_linux_amd64.tar.gz
+chmod +x joven
+sudo mv joven /usr/local/bin/
+```
+
 ## Configuration
 
 Joven uses a configuration file to store settings. 

cmd/root.go

@@ -11,8 +11,7 @@ import (
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
-	Use:   "joven",
-
+	Use: "joven",
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.

terraform/community.go

@@ -5,8 +5,6 @@ import (
 	"net/http"
 	"net/url"
 	"strings"
-
-	"github.com/netvolart/joven/config"
 )
 
 func getModuleVersionsFromRegistry(url string, localModule LocalModule) (module TerraformModule, Error error) {
@@ -41,7 +39,7 @@ func getModuleVersionsFromRegistry(url string, localModule LocalModule) (module
 
 }
 
-func CreateModuleGitlabUrl(c *config.Config, moduleName string) (string, error) {
+func createModuleCommunityUrl(moduleName string) (string, error) {
 	if moduleName == "" {
 		return "", ErrorPageNumberEmpty
 	}

terraform/community_test.go

@@ -78,8 +78,7 @@ func createRegistryMockServer(t *testing.T) *httptest.Server {
 
 func TestCreateModuleCommunityUrl(t *testing.T) {
 	t.Run("Test First page", func(t *testing.T) {
-		config := generateMockConfig(t)
-		url, err := CreateModuleGitlabUrl(config, "registry.terraform.io/terraform-aws-modules/vpc/aws")
+		url, err := createModuleCommunityUrl("registry.terraform.io/terraform-aws-modules/vpc/aws")
 		if err != nil {
 			t.Errorf("Unable to generate URL %s", err)
 		}
@@ -89,8 +88,7 @@ func TestCreateModuleCommunityUrl(t *testing.T) {
 		}
 	})
 	t.Run("Test Empty page", func(t *testing.T) {
-		config := generateMockConfig(t)
-		_, err := createModuleGitlabUrl(config, "")
+		_, err := createModuleCommunityUrl("")
 
 		if err != ErrorPageNumberEmpty {
 			t.Errorf("got %s want %s given", ErrorPageNumberEmpty, err)

terraform/compare.go

@@ -32,7 +32,7 @@ func findOutdated(modules []*TerraformModule) ([]*TerraformModule, error) {
 
 func CompareGitLabModules(c *config.Config, localModulesData []byte) ([]*TerraformModule, error) {
 	// parse local modules
-	localModulesResult, err := GetLocalModules(localModulesData)
+	localModulesResult, err := getLocalModules(localModulesData)
 	if err != nil {
 		return nil, err
 	}
@@ -65,15 +65,14 @@ func CompareGitLabModules(c *config.Config, localModulesData []byte) ([]*Terrafo
 
 		} else if localModule.Type == "community" {
 
-			url, err := CreateModuleGitlabUrl(c, localModule.Source)
+			url, err := createModuleCommunityUrl(localModule.Source)
 			if err != nil {
 				return nil, err
 			}
 			communityModule, err := getModuleVersionsFromRegistry(url, localModule)
 			if err != nil {
 				return nil, err
 			}
-			//		log.Println(communityModule)
 			resultModules = append(resultModules, &communityModule)
 		}
 

terraform/gitlab_batch.go

@@ -3,7 +3,6 @@ package terraform
 import (
 	"encoding/json"
 	"fmt"
-	"log"
 	"net/http"
 	"net/url"
 	"strconv"
@@ -59,62 +58,3 @@ func makeGiLabModulesRequest(c *config.Config, url string) (modulesResp *[]Respo
 	}
 	return &responses, totalPages, nil
 }
-
-func downloadModulesMetadata(c *config.Config) ([]Response, error) {
-	url, err := createGitLabUrl(c, "1")
-	if err != nil {
-		return nil, err
-	}
-	responses, totalPages, err := makeGiLabModulesRequest(c, url)
-	if err != nil {
-		return nil, err
-	}
-
-	var fullResponses []Response
-
-	fullResponses = append(fullResponses, *responses...)
-	resultChannel := make(chan *[]Response)
-	for i := 2; i <= totalPages; i++ {
-
-		url, err := createGitLabUrl(c, strconv.Itoa(i))
-		if err != nil {
-			return nil, err
-		}
-		go func(c *config.Config, url string) {
-			responses, _, err := makeGiLabModulesRequest(c, url)
-			if err != nil {
-				log.Println(err)
-				return
-			}
-			resultChannel <- responses
-		}(c, url)
-
-		fullResponses = append(fullResponses, *responses...)
-	}
-	for i := 2; i <= totalPages; i++ {
-		r := <-resultChannel
-		fullResponses = append(fullResponses, *r...)
-	}
-	return fullResponses, nil
-}
-
-func GetModulesFromGitlab(c *config.Config) ([]*TerraformModule, error) {
-	responses, err := downloadModulesMetadata(c)
-	if err != nil {
-		log.Printf("Error getting modules from GitLab: %v", err)
-
-	}
-	var modules []*TerraformModule
-	for _, response := range responses {
-		link := "https://gitlab.com" + response.Links.WebPath
-		module := NewTerraformModule(response.Name, "", response.Version, link, false)
-		modules = append(modules, module)
-	}
-
-	cleared, err := clearOldVersions(modules)
-	if err != nil {
-		log.Printf("Unable to clean modules: %v", err)
-	}
-
-	return cleared, nil
-}

terraform/local.go

@@ -47,7 +47,7 @@ type LocalModules struct {
 	Modules []LocalModule `json:"Modules"`
 }
 
-func GetLocalModules(data []byte) (*LocalModules, error) {
+func getLocalModules(data []byte) (*LocalModules, error) {
 	var localModules LocalModules
 	err := json.Unmarshal(data, &localModules)
 	if err != nil {

terraform/local_test.go

@@ -34,7 +34,7 @@ func TestGetLocalModules(t *testing.T) {
 		]
 	}`
 
-	localModules, err := GetLocalModules([]byte(data))
+	localModules, err := getLocalModules([]byte(data))
 	if err != nil {
 		t.Errorf(err.Error())
 	}