Add documentation for using localstack (#30)

* Add documentation for using localstack

* Add functionality to accept localstack port from cli

README.md

@@ -54,6 +54,14 @@ For updating to latest version, use:
 ```console
 cloudlens update
 ```
+### Using Localstack
+- Configure localstack server. 
+-  Use our repo [cloud-lens-populator](https://github.com/one2nc/cloud-lens-populator) to setup and populate dummy data.
+- To run cloudlens with localstack use `aws` sub-command with `-l` or `--localstack` flag 
+- By default cloudlens use port `4566`. Use   `--port` flag to pass different port
+```console
+cloudlens aws --localstack --port 4000
+```
 
 ## Features
 

cmd/aws.go

@@ -1,6 +1,8 @@
 package cmd
 
 import (
+	"os"
+
 	"github.com/one2nc/cloudlens/internal"
 	"github.com/spf13/cobra"
 )
@@ -17,9 +19,10 @@ func awsCommand() *cobra.Command {
 	}
 
 	command.Flags().StringVarP(&profile, "profile", "p", "default", "Read aws profile")
-
 	command.Flags().StringVarP(&region, "region", "r", "", "Read aws region")
+
 	command.Flags().BoolVarP(&useLocalStack, "localstack", "l", false, "Use localsatck instead of AWS")
+	command.Flags().StringVarP(&localStackPort, "port", "", "4566", "Read localstack port")
 
 	return &command
 }
@@ -29,6 +32,8 @@ func selectAWS() {
 	cloudConfig.AWSConfig.Profile = profile
 	cloudConfig.AWSConfig.Region = region
 	cloudConfig.AWSConfig.UseLocalStack = useLocalStack
+	cloudConfig.AWSConfig.LocalStackPort = localStackPort
 
+	os.Setenv(internal.LOCALSTACK_PORT, cloudConfig.LocalStackPort)
 	initView()
 }

cmd/constants.go

@@ -1,7 +1,6 @@
 package cmd
 
 const (
-	localstackEndpoint string = "http://localhost:4566"
 	AWS_PROFILE        string = "AWS_PROFILE"
 	AWS_DEFAULT_REGION string = "AWS_DEFAULT_REGION"
 )

cmd/gcp.go

@@ -25,7 +25,7 @@ func gcpCommand() *cobra.Command {
 
 func selectGCP() {
 	cloudConfig.SelectedCloud = internal.GCP
-	os.Setenv("GOOGLE_APPLICATION_CREDENTIALS", gcpCredFilePath)
+	os.Setenv(internal.GOOGLE_APPLICATION_CREDENTIALS, gcpCredFilePath)
 	cloudConfig.CredFilePath = gcpCredFilePath
 
 	initView()

cmd/root.go

@@ -13,12 +13,12 @@ import (
 )
 
 var (
-	profile, region, gcpCredFilePath string
-	useLocalStack bool
-	version                          = "dev"
-	commit                           = "dev"
-	date                             = "today"
-	rootCmd                          = &cobra.Command{
+	profile, region, gcpCredFilePath, localStackPort string
+	useLocalStack                                    bool
+	version                                          = "dev"
+	commit                                           = "dev"
+	date                                             = "today"
+	rootCmd                                          = &cobra.Command{
 		Use:   `cloudlens`,
 		Short: `cli for cloud services`,
 		Long:  `cli for cloud services[aws,gcp]`,

internal/aws/config.go

@@ -3,6 +3,7 @@ package aws
 import (
 	"context"
 	"errors"
+	"fmt"
 	"os"
 	"strings"
 
@@ -13,6 +14,7 @@ import (
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/aws/aws-sdk-go/aws/credentials"
 	"github.com/aws/aws-sdk-go/aws/defaults"
+	"github.com/one2nc/cloudlens/internal"
 	"github.com/rs/zerolog/log"
 	"gopkg.in/ini.v1"
 )
@@ -144,7 +146,7 @@ func GetProfiles() (profiles []string, err error) {
 func GetLocalstackCfg(region string) (awsV2.Config, error) {
 	customResolver := awsV2.EndpointResolverFunc(func(service, region string) (awsV2.Endpoint, error) {
 		return awsV2.Endpoint{
-			URL:           "http://localhost:4566",
+			URL:           GetLocastackEndpoint(),
 			SigningRegion: region,
 		}, nil
 	})
@@ -158,3 +160,10 @@ func GetLocalstackCfg(region string) (awsV2.Config, error) {
 	}
 	return awsLSCfg, nil
 }
+
+func GetLocastackEndpoint() string {
+
+	port := os.Getenv(internal.LOCALSTACK_PORT)
+
+	return fmt.Sprintf("http://localhost:%v", port)
+}

internal/config/cloud_config.go

@@ -7,9 +7,10 @@ type CloudConfig struct {
 }
 
 type AWSConfig struct {
-	Profile string
-	Region  string
-	UseLocalStack bool
+	Profile        string
+	Region         string
+	UseLocalStack  bool
+	LocalStackPort string
 }
 type GCPConfig struct {
 	CredFilePath string

internal/config/constants.go

@@ -1,5 +1 @@
 package config
-
-const (
-	localstackEndpoint string = "http://localhost:4566"
-)

internal/constants.go

@@ -96,5 +96,10 @@ const (
 const (
 	FOLDER_TYPE string = "Folder"
 	FILE_TYPE   string = "File"
-	NONE string = "-"
+	NONE        string = "-"
+)
+
+const (
+	LOCALSTACK_PORT                string = "LOCALSTACK_PORT"
+	GOOGLE_APPLICATION_CREDENTIALS string = "GOOGLE_APPLICATION_CREDENTIALS"
 )

internal/view/app.go

@@ -157,7 +157,7 @@ func (a *App) handleAWS() {
 func (a *App) handleGCP() error {
 	ctx := a.GetContext()
 	ctx = context.WithValue(ctx, internal.KeySelectedCloud, internal.GCP)
-	credFilePath := os.Getenv("GOOGLE_APPLICATION_CREDENTIALS")
+	credFilePath := os.Getenv(internal.GOOGLE_APPLICATION_CREDENTIALS)
 	if credFilePath == "" {
 		go func() {
 			<-time.After(splashDelay)