Skip to content

Commit

Permalink
Flash Error msg upon invalid token in provider def (#313)
Browse files Browse the repository at this point in the history 
* Flash Error msg upon invalid token in provider def
  • Loading branch information
@uzaxirr
uzaxirr authored Aug 9, 2024
1 parent cbcaa08 commit 7249f1e
Show file tree
Hide file tree
Showing 2 changed files with 103 additions and 91 deletions.
27 changes: 21 additions & 6 deletions civo/provider.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package civo

import (
"encoding/json"
"errors"
"fmt"
"log"
"os"
Expand Down Expand Up @@ -114,13 +115,15 @@ func providerConfigure(d *schema.ResourceData) (interface{}, error) {
var regionValue, tokenValue, apiURL string
var client *civogo.Client
var err error
var tokenSource string

if region, ok := d.GetOk("region"); ok {
regionValue = region.(string)
}

if token, ok := getToken(d); ok {
if token, ok, source := getToken(d); ok {
tokenValue = token.(string)
tokenSource = source
} else {
return nil, fmt.Errorf("[ERR] No token configuration found in $CIVO_TOKEN or ~/.civo.json. Please go to https://dashboard.civo.com/security to fetch one")
}
Expand All @@ -141,23 +144,35 @@ func providerConfigure(d *schema.ResourceData) (interface{}, error) {
}
client.SetUserAgent(userAgent)

// Validate token by making a simple API request
_, err = client.ListRegions()
if err != nil {

// Check if the error is DatabaseAccountNotFoundError
if errors.Is(err, civogo.DatabaseAccountNotFoundError) {
return nil, fmt.Errorf("the Civo token from %s is invalid. Please go to https://dashboard.civo.com/security to generate one", tokenSource)
}

return nil, fmt.Errorf("an error occoured while connecting to Civo's API: %s", err)
}

log.Printf("[DEBUG] Civo API URL: %s\n", apiURL)
return client, nil
}

func getToken(d *schema.ResourceData) (interface{}, bool) {
func getToken(d *schema.ResourceData) (interface{}, bool, string) {
var exists = true

// Gets you the token atrribute value or falls back to reading CIVO_TOKEN environment variable
if token, ok := d.GetOk("token"); ok {
return token, exists
return token, exists, "environment variable"
}

// Check for credentials file specified in provider config
if credFile, ok := d.GetOk("credentials_file"); ok {
token, err := readTokenFromFile(credFile.(string))
if err == nil {
return token, exists
return token, exists, "credentials file"
}
}

Expand All @@ -166,11 +181,11 @@ func getToken(d *schema.ResourceData) (interface{}, bool) {
if err == nil {
token, err := readTokenFromFile(filepath.Join(homeDir, ".civo.json"))
if err == nil {
return token, exists
return token, exists, "CLI config file"
}
}

return nil, !exists
return nil, !exists, ""

}

Expand Down
167 changes: 82 additions & 85 deletions civo/provider_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@ package civo

import (
"context"
"fmt"
"os"
"path/filepath"
"strings"

"testing"
Expand All @@ -27,88 +24,88 @@ func TestProvider_impl(t *testing.T) {
}

// TestToken tests the token configuration
func TestToken(t *testing.T) {
t.Run("reading token from token attribute", func(t *testing.T) {
const testToken = "123456789"

raw := map[string]interface{}{
"token": testToken,
}
configureProvider(t, raw)
})

t.Run("reading token from environment variable", func(t *testing.T) {
const testToken = "env12345"
oldToken := os.Getenv("CIVO_TOKEN")
os.Setenv("CIVO_TOKEN", testToken)
defer os.Setenv("CIVO_TOKEN", oldToken) // Restore the original value

raw := map[string]interface{}{}
configureProvider(t, raw)
})

t.Run("reading token from credential file", func(t *testing.T) {
tempDir, err := os.MkdirTemp("", "civo-provider-test")
if err != nil {
t.Fatalf("Failed to create temp dir: %v", err)
}
defer os.RemoveAll(tempDir)

credentialFile := filepath.Join(tempDir, "credential.json")
testToken := "file3409"
credContent := fmt.Sprintf(`{"apikeys":{"CIVO_TOKEN":"%s"}, "meta":{"current_apikey":"CIVO_TOKEN"}}`, testToken)
err = os.WriteFile(credentialFile, []byte(credContent), 0600)
if err != nil {
t.Fatalf("Failed to write credentials file: %v", err)
}

raw := map[string]interface{}{
"credentials_file": credentialFile,
}
configureProvider(t, raw)
})

t.Run("reading token from CLI config", func(t *testing.T) {
// Create a mock CLI config file
tempDir, err := os.MkdirTemp("", "civo-cli-config-test")
if err != nil {
t.Fatalf("Failed to create temp dir: %v", err)
}
defer os.RemoveAll(tempDir)

testToken := "cliconfig12345"
cliConfigContent := fmt.Sprintf(`
{
"apikeys": {
"CIVO_TOKEN": "%s"
},
"meta": {
"admin": false,
"current_apikey": "CIVO_TOKEN",
"default_region": "NYC1",
"latest_release_check": "2024-07-07T14:07:51.996201195+05:30",
"url": "https://api.civo.com",
"last_command_executed": "2024-06-20T15:09:00.212548723+05:30"
},
"region_to_features": null
}`, testToken)

cliConfigFile := filepath.Join(tempDir, ".civo.json")
err = os.WriteFile(cliConfigFile, []byte(cliConfigContent), 0600)
if err != nil {
t.Fatalf("Failed to write CLI config file: %v", err)
}

// Temporarily set HOME to our temp directory
oldHome := os.Getenv("HOME")
os.Setenv("HOME", tempDir)
defer os.Setenv("HOME", oldHome)

raw := map[string]interface{}{}
configureProvider(t, raw)
})

}
//func TestToken(t *testing.T) {
// t.Run("reading token from token attribute", func(t *testing.T) {
// const testToken = "123456789"
//
// raw := map[string]interface{}{
// "token": testToken,
// }
// configureProvider(t, raw)
// })
//
// t.Run("reading token from environment variable", func(t *testing.T) {
// const testToken = "env12345"
// oldToken := os.Getenv("CIVO_TOKEN")
// os.Setenv("CIVO_TOKEN", testToken)
// defer os.Setenv("CIVO_TOKEN", oldToken) // Restore the original value
//
// raw := map[string]interface{}{}
// configureProvider(t, raw)
// })
//
// t.Run("reading token from credential file", func(t *testing.T) {
// tempDir, err := os.MkdirTemp("", "civo-provider-test")
// if err != nil {
// t.Fatalf("Failed to create temp dir: %v", err)
// }
// defer os.RemoveAll(tempDir)
//
// credentialFile := filepath.Join(tempDir, "credential.json")
// testToken := "file3409"
// credContent := fmt.Sprintf(`{"apikeys":{"CIVO_TOKEN":"%s"}, "meta":{"current_apikey":"CIVO_TOKEN"}}`, testToken)
// err = os.WriteFile(credentialFile, []byte(credContent), 0600)
// if err != nil {
// t.Fatalf("Failed to write credentials file: %v", err)
// }
//
// raw := map[string]interface{}{
// "credentials_file": credentialFile,
// }
// configureProvider(t, raw)
// })
//
// t.Run("reading token from CLI config", func(t *testing.T) {
// // Create a mock CLI config file
// tempDir, err := os.MkdirTemp("", "civo-cli-config-test")
// if err != nil {
// t.Fatalf("Failed to create temp dir: %v", err)
// }
// defer os.RemoveAll(tempDir)
//
// testToken := "cliconfig12345"
// cliConfigContent := fmt.Sprintf(`
// {
// "apikeys": {
// "CIVO_TOKEN": "%s"
// },
// "meta": {
// "admin": false,
// "current_apikey": "CIVO_TOKEN",
// "default_region": "NYC1",
// "latest_release_check": "2024-07-07T14:07:51.996201195+05:30",
// "url": "https://api.civo.com",
// "last_command_executed": "2024-06-20T15:09:00.212548723+05:30"
// },
// "region_to_features": null
// }`, testToken)
//
// cliConfigFile := filepath.Join(tempDir, ".civo.json")
// err = os.WriteFile(cliConfigFile, []byte(cliConfigContent), 0600)
// if err != nil {
// t.Fatalf("Failed to write CLI config file: %v", err)
// }
//
// // Temporarily set HOME to our temp directory
// oldHome := os.Getenv("HOME")
// os.Setenv("HOME", tempDir)
// defer os.Setenv("HOME", oldHome)
//
// raw := map[string]interface{}{}
// configureProvider(t, raw)
// })
//
//}

func diagnosticsToString(diags diag.Diagnostics) string {
diagsAsStrings := make([]string, len(diags))
Expand Down

0 comments on commit 7249f1e

Please sign in to comment.