Skip to content
This repository was archived by the owner on Mar 22, 2018. It is now read-only.

Commit fd023c5

Browse files
committed
fix some bugs and add unit tests
1 parent 7da3e61 commit fd023c5

7 files changed

Lines changed: 164 additions & 38 deletions

File tree

app/cinderplugin/main.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ import (
2525
)
2626

2727
var (
28-
endpoint string
29-
nodeID string
30-
config string
28+
endpoint string
29+
nodeID string
30+
cloudconfig string
3131
)
3232

3333
func main() {
@@ -45,8 +45,8 @@ func main() {
4545
cmd.PersistentFlags().StringVar(&endpoint, "endpoint", "", "CSI endpoint")
4646
cmd.MarkPersistentFlagRequired("endpoint")
4747

48-
cmd.PersistentFlags().StringVar(&config, "config", "", "CSI drive config")
49-
cmd.MarkPersistentFlagRequired("config")
48+
cmd.PersistentFlags().StringVar(&cloudconfig, "cloud-config", "", "CSI driver cloud config")
49+
cmd.MarkPersistentFlagRequired("cloud-config")
5050

5151
if err := cmd.Execute(); err != nil {
5252
fmt.Fprintf(os.Stderr, "%s", err.Error())
@@ -57,6 +57,6 @@ func main() {
5757
}
5858

5959
func handle() {
60-
d := cinder.NewDriver(nodeID, endpoint, config)
60+
d := cinder.NewDriver(nodeID, endpoint, cloudconfig)
6161
d.Run()
6262
}

pkg/cinder/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Start Cinder driver
66
```
7-
$ sudo ./_output/cinderplugin --endpoint tcp://127.0.0.1:10000 --config /etc/openstack.conf --nodeid CSINodeID
7+
$ sudo ./_output/cinderplugin --endpoint tcp://127.0.0.1:10000 --cloud-config /etc/cloud.conf --nodeid CSINodeID
88
```
99

1010
### Test using csc

pkg/cinder/driver.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ import (
2525
)
2626

2727
type driver struct {
28-
csiDriver *csicommon.CSIDriver
29-
endpoint string
30-
config string
28+
csiDriver *csicommon.CSIDriver
29+
endpoint string
30+
cloudconfig string
3131

3232
ids *csicommon.DefaultIdentityServer
3333
cs *controllerServer
@@ -51,13 +51,13 @@ func GetSupportedVersions() []*csi.Version {
5151
return []*csi.Version{&version}
5252
}
5353

54-
func NewDriver(nodeID, endpoint string, config string) *driver {
54+
func NewDriver(nodeID, endpoint string, cloudconfig string) *driver {
5555
glog.Infof("Driver: %v version: %v", driverName, csicommon.GetVersionString(&version))
5656

5757
d := &driver{}
5858

5959
d.endpoint = endpoint
60-
d.config = config
60+
d.cloudconfig = cloudconfig
6161

6262
csiDriver := csicommon.NewCSIDriver(driverName, &version, GetSupportedVersions(), nodeID)
6363
csiDriver.AddControllerServiceCapabilities([]csi.ControllerServiceCapability_RPC_Type{csi.ControllerServiceCapability_RPC_CREATE_DELETE_VOLUME})
@@ -82,6 +82,6 @@ func NewNodeServer(d *driver) *nodeServer {
8282
}
8383

8484
func (d *driver) Run() {
85-
openstack.InitOpenStackProvider(d.config)
85+
openstack.InitOpenStackProvider(d.cloudconfig)
8686
csicommon.RunControllerandNodePublishServer(d.endpoint, d.csiDriver, NewControllerServer(d), NewNodeServer(d))
8787
}

pkg/cinder/etc/cloud.conf

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[Global]
2+
username=user
3+
password=pass
4+
auth-url=https://<keystone_ip>/identity/v3
5+
tenant-id=c869168a828847f39f7f06edd7305637
6+
domain-id=2a73b8f597c04551a0fdc8e95544be8a

pkg/cinder/fake.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import (
2222

2323
var fakeNodeID = "CSINodeID"
2424
var fakeEndpoint = "tcp://127.0.0.1:10000"
25-
var fakeConfig = "/etc/openstack.conf"
25+
var fakeConfig = "/etc/cloud.conf"
2626
var fakeCtx = context.Background()
2727
var fakeVolName = "CSIVolumeName"
2828
var fakeVolID = "CSIVolumeID"

pkg/cinder/openstack/openstack.go

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,14 @@ func (cfg Config) toAuthOptions() gophercloud.AuthOptions {
7070
}
7171
}
7272

73-
func getConfigFromFile(configFilePath string) (gophercloud.AuthOptions, string, error) {
73+
func GetConfigFromFile(configFilePath string) (gophercloud.AuthOptions, gophercloud.EndpointOpts, error) {
7474
// Get config from file
75-
var opts gophercloud.AuthOptions
75+
var authOpts gophercloud.AuthOptions
76+
var epOpts gophercloud.EndpointOpts
7677
config, err := os.Open(configFilePath)
7778
if err != nil {
7879
glog.V(3).Infof("Failed to open OpenStack configuration file: %v", err)
79-
return opts, "", err
80+
return authOpts, epOpts, err
8081
}
8182
defer config.Close()
8283

@@ -85,31 +86,35 @@ func getConfigFromFile(configFilePath string) (gophercloud.AuthOptions, string,
8586
err = gcfg.ReadInto(&cfg, config)
8687
if err != nil {
8788
glog.V(3).Infof("Failed to read OpenStack configuration file: %v", err)
88-
return opts, "", err
89+
return authOpts, epOpts, err
8990
}
9091

91-
opts = cfg.toAuthOptions()
92-
region := cfg.Global.Region
92+
authOpts = cfg.toAuthOptions()
93+
epOpts = gophercloud.EndpointOpts{
94+
Region: cfg.Global.Region,
95+
}
9396

94-
return opts, region, nil
97+
return authOpts, epOpts, nil
9598
}
9699

97-
func getConfigFromEnv() (gophercloud.AuthOptions, string, error) {
100+
func GetConfigFromEnv() (gophercloud.AuthOptions, gophercloud.EndpointOpts, error) {
98101
// Get config from env
99-
opts, err := openstack.AuthOptionsFromEnv()
102+
authOpts, err := openstack.AuthOptionsFromEnv()
103+
var epOpts gophercloud.EndpointOpts
100104
if err != nil {
101105
glog.V(3).Infof("Failed to read OpenStack configuration from env: %v", err)
102-
return opts, "", err
106+
return authOpts, epOpts, err
107+
}
108+
109+
epOpts = gophercloud.EndpointOpts{
110+
Region: os.Getenv("OS_REGION_NAME"),
103111
}
104112

105-
// Get Region from env
106-
region := os.Getenv("OS_REGION_NAME")
107-
108-
return opts, region, nil
113+
return authOpts, epOpts, nil
109114
}
110115

111116
var OsInstance IOpenStack = nil
112-
var configFile string = "/etc/openstack.conf"
117+
var configFile string = "/etc/cloud.conf"
113118

114119
func InitOpenStackProvider(cfg string) {
115120
configFile = cfg
@@ -120,33 +125,29 @@ func GetOpenStackProvider() (IOpenStack, error) {
120125

121126
if OsInstance == nil {
122127
// Get config from file
123-
opts, region, err := getConfigFromFile(configFile)
128+
authOpts, epOpts, err := GetConfigFromFile(configFile)
124129
if err != nil {
125130
// Get config from env
126-
opts, region, err = getConfigFromEnv()
131+
authOpts, epOpts, err = GetConfigFromEnv()
127132
if err != nil {
128133
return nil, err
129134
}
130135
}
131136

132137
// Authenticate Client
133-
provider, err := openstack.AuthenticatedClient(opts)
138+
provider, err := openstack.AuthenticatedClient(authOpts)
134139
if err != nil {
135140
return nil, err
136141
}
137142

138143
// Init Nova ServiceClient
139-
computeclient, err := openstack.NewComputeV2(provider, gophercloud.EndpointOpts{
140-
Region: region,
141-
})
144+
computeclient, err := openstack.NewComputeV2(provider, epOpts)
142145
if err != nil {
143146
return nil, err
144147
}
145148

146149
// Init Cinder ServiceClient
147-
blockstorageclient, err := openstack.NewBlockStorageV3(provider, gophercloud.EndpointOpts{
148-
Region: region,
149-
})
150+
blockstorageclient, err := openstack.NewBlockStorageV3(provider, epOpts)
150151
if err != nil {
151152
return nil, err
152153
}
Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
/*
2+
Copyright 2017 The Kubernetes Authors.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
package openstack
18+
19+
import (
20+
"os"
21+
"testing"
22+
23+
"github.com/gophercloud/gophercloud"
24+
"github.com/stretchr/testify/assert"
25+
)
26+
27+
var fakeFileName = "cloud.conf"
28+
var fakeUserName = "user"
29+
var fakePassword = "pass"
30+
var fakeAuthUrl = "https://169.254.169.254/identity/v3"
31+
var fakeTenantID = "c869168a828847f39f7f06edd7305637"
32+
var fakeDomainID = "2a73b8f597c04551a0fdc8e95544be8a"
33+
var fakeRegion = "RegionOne"
34+
35+
// Test GetConfigFromFile
36+
func TestGetConfigFromFile(t *testing.T) {
37+
// init file
38+
var fakeFileContent = `
39+
[Global]
40+
username=` + fakeUserName + `
41+
password=` + fakePassword + `
42+
auth-url=` + fakeAuthUrl + `
43+
tenant-id=` + fakeTenantID + `
44+
domain-id=` + fakeDomainID + `
45+
region=` + fakeRegion + `
46+
`
47+
48+
f, err := os.Create(fakeFileName)
49+
if err != nil {
50+
t.Errorf("failed to create file: %v", err)
51+
}
52+
53+
_, err = f.WriteString(fakeFileContent)
54+
f.Close()
55+
if err != nil {
56+
t.Errorf("failed to write file: %v", err)
57+
}
58+
defer os.Remove(fakeFileName)
59+
60+
// Init assert
61+
assert := assert.New(t)
62+
63+
expectedAuthOpts := gophercloud.AuthOptions{
64+
IdentityEndpoint: fakeAuthUrl,
65+
Username: fakeUserName,
66+
Password: fakePassword,
67+
TenantID: fakeTenantID,
68+
DomainID: fakeDomainID,
69+
AllowReauth: true,
70+
}
71+
expectedEpOpts := gophercloud.EndpointOpts{
72+
Region: fakeRegion,
73+
}
74+
75+
// Invoke GetConfigFromFile
76+
actualAuthOpts, actualEpOpts, err := GetConfigFromFile(fakeFileName)
77+
if err != nil {
78+
t.Errorf("failed to GetConfigFromFile: %v", err)
79+
}
80+
81+
// Assert
82+
assert.Equal(expectedAuthOpts, actualAuthOpts)
83+
assert.Equal(expectedEpOpts, actualEpOpts)
84+
}
85+
86+
// Test GetConfigFromEnv
87+
func TestGetConfigFromEnv(t *testing.T) {
88+
// init env
89+
os.Setenv("OS_AUTH_URL", fakeAuthUrl)
90+
os.Setenv("OS_USERNAME", fakeUserName)
91+
os.Setenv("OS_PASSWORD", fakePassword)
92+
os.Setenv("OS_TENANT_ID", fakeTenantID)
93+
os.Setenv("OS_DOMAIN_ID", fakeDomainID)
94+
os.Setenv("OS_REGION_NAME", fakeRegion)
95+
96+
// Init assert
97+
assert := assert.New(t)
98+
99+
expectedAuthOpts := gophercloud.AuthOptions{
100+
IdentityEndpoint: fakeAuthUrl,
101+
Username: fakeUserName,
102+
Password: fakePassword,
103+
TenantID: fakeTenantID,
104+
DomainID: fakeDomainID,
105+
}
106+
expectedEpOpts := gophercloud.EndpointOpts{
107+
Region: fakeRegion,
108+
}
109+
110+
// Invoke GetConfigFromEnv
111+
actualAuthOpts, actualEpOpts, err := GetConfigFromEnv()
112+
if err != nil {
113+
t.Errorf("failed to GetConfigFromEnv: %v", err)
114+
}
115+
116+
// Assert
117+
assert.Equal(expectedAuthOpts, actualAuthOpts)
118+
assert.Equal(expectedEpOpts, actualEpOpts)
119+
}

0 commit comments

Comments
 (0)