Merge pull request #35 from jtopjian/clientconfig-docs

Doc Update and NewServiceProvider fix

Author: jtopjian

acceptance/openstack/clientconfig/clientconfig_test.go

@@ -14,10 +14,8 @@ import (
 )
 
 func TestServerCreateDestroy(t *testing.T) {
-	clientOpts := &cc.ClientOpts{
-		Cloud:     "acctest",
-		EnvPrefix: "FOO",
-	}
+	// This will be populated by environment variables.
+	clientOpts := &cc.ClientOpts{}
 
 	client, err := cc.NewServiceClient("compute", clientOpts)
 	if err != nil {

openstack/clientconfig/.requests.go.swp

@@ -16,6 +16,24 @@ Example to Create a Provider Client From clouds.yaml
 	}
 
 
+Example to Manually Create a Provider Client
+
+	opts := &clientconfig.ClientOpts{
+		AuthInfo: &clientconfig.AuthInfo{
+			AuthURL:     "https://hi.example.com:5000/v3",
+			Username:    "jdoe",
+			Password:    "password",
+			ProjectName: "Some Project",
+			DomainName:  "default",
+		},
+	}
+
+	pClient, err := clientconfig.AuthenticatedClient(opts)
+	if err != nil {
+		panic(err)
+	}
+
+
 Example to Create a Service Client from clouds.yaml
 
 	opts := &clientconfig.ClientOpts{

openstack/clientconfig/doc.go

@@ -426,8 +426,33 @@ func AuthenticatedClient(opts *ClientOpts) (*gophercloud.ProviderClient, error)
 
 // NewServiceClient is a convenience function to get a new service client.
 func NewServiceClient(service string, opts *ClientOpts) (*gophercloud.ServiceClient, error) {
-	var cloud *Cloud
+	cloud := new(Cloud)
+
+	// If no opts were passed in, create an empty ClientOpts.
+	if opts == nil {
+		opts = new(ClientOpts)
+	}
+
+	// Determine if a clouds.yaml entry should be retrieved.
+	// Start by figuring out the cloud name.
+	// First check if one was explicitly specified in opts.
+	var cloudName string
 	if opts.Cloud != "" {
+		cloudName = opts.Cloud
+	}
+
+	// Next see if a cloud name was specified as an environment variable.
+	envPrefix := "OS_"
+	if opts.EnvPrefix != "" {
+		envPrefix = opts.EnvPrefix
+	}
+
+	if v := os.Getenv(envPrefix + "CLOUD"); v != "" {
+		cloudName = v
+	}
+
+	// If a cloud name was determined, try to look it up in clouds.yaml.
+	if cloudName != "" {
 		// Get the requested cloud.
 		var err error
 		cloud, err = GetCloudFromYAML(opts)
@@ -436,16 +461,6 @@ func NewServiceClient(service string, opts *ClientOpts) (*gophercloud.ServiceCli
 		}
 	}
 
-	if cloud == nil {
-		cloud.AuthInfo = opts.AuthInfo
-	}
-
-	// Environment variable overrides.
-	envPrefix := "OS_"
-	if opts != nil && opts.EnvPrefix != "" {
-		envPrefix = opts.EnvPrefix
-	}
-
 	// Get a Provider Client
 	pClient, err := AuthenticatedClient(opts)
 	if err != nil {