Skip to content

Commit 8dd100a

Browse files
raja-sami-10praja-sami-10p
committed
Increase the Coverage of pkg/plugins
Increases the test coverage of pkg/plugins. Changed signature of function NewClientWithTimeout in pkg/plugin/client, to take time.Duration instead of integers. Signed-off-by: Raja Sami <[email protected]>
1 parent 3f6b6c2 commit 8dd100a

6 files changed

Lines changed: 259 additions & 9 deletions

File tree

‎pkg/plugins/client.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,20 +57,20 @@ func NewClient(addr string, tlsConfig *tlsconfig.Options) (*Client, error) {
5757
}
5858

5959
// NewClientWithTimeout creates a new plugin client (http).
60-
func NewClientWithTimeout(addr string, tlsConfig *tlsconfig.Options, timeoutInSecs int) (*Client, error) {
60+
func NewClientWithTimeout(addr string, tlsConfig *tlsconfig.Options, timeout time.Duration) (*Client, error) {
6161
clientTransport, err := newTransport(addr, tlsConfig)
6262
if err != nil {
6363
return nil, err
6464
}
65-
return newClientWithTransport(clientTransport, timeoutInSecs), nil
65+
return newClientWithTransport(clientTransport, timeout), nil
6666
}
6767

6868
// newClientWithTransport creates a new plugin client with a given transport.
69-
func newClientWithTransport(tr transport.Transport, timeoutInSecs int) *Client {
69+
func newClientWithTransport(tr transport.Transport, timeout time.Duration) *Client {
7070
return &Client{
7171
http: &http.Client{
7272
Transport: tr,
73-
Timeout: time.Duration(timeoutInSecs) * time.Second,
73+
Timeout: timeout,
7474
},
7575
requestFactory: tr,
7676
}

‎pkg/plugins/client_test.go‎

Lines changed: 83 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
package plugins
22

33
import (
4+
"bytes"
5+
"encoding/json"
46
"io"
57
"net/http"
68
"net/http/httptest"
79
"net/url"
8-
"reflect"
910
"strings"
1011
"testing"
1112
"time"
1213

1314
"github.com/docker/docker/pkg/plugins/transport"
1415
"github.com/docker/go-connections/tlsconfig"
16+
"github.com/stretchr/testify/assert"
1517
)
1618

1719
var (
@@ -83,9 +85,7 @@ func TestEchoInputOutput(t *testing.T) {
8385
t.Fatal(err)
8486
}
8587

86-
if !reflect.DeepEqual(output, m) {
87-
t.Fatalf("Expected %v, was %v\n", m, output)
88-
}
88+
assert.Equal(t, m, output)
8989
err = c.Call("Test.Echo", nil, nil)
9090
if err != nil {
9191
t.Fatal(err)
@@ -153,3 +153,82 @@ func TestClientScheme(t *testing.T) {
153153
}
154154
}
155155
}
156+
157+
func TestNewClientWithTimeout(t *testing.T) {
158+
addr := setupRemotePluginServer()
159+
defer teardownRemotePluginServer()
160+
161+
m := Manifest{[]string{"VolumeDriver", "NetworkDriver"}}
162+
163+
mux.HandleFunc("/Test.Echo", func(w http.ResponseWriter, r *http.Request) {
164+
time.Sleep(time.Duration(600) * time.Millisecond)
165+
io.Copy(w, r.Body)
166+
})
167+
168+
// setting timeout of 500ms
169+
timeout := time.Duration(500) * time.Millisecond
170+
c, _ := NewClientWithTimeout(addr, &tlsconfig.Options{InsecureSkipVerify: true}, timeout)
171+
var output Manifest
172+
err := c.Call("Test.Echo", m, &output)
173+
if err == nil {
174+
t.Fatal("Expected timeout error")
175+
}
176+
}
177+
178+
func TestClientStream(t *testing.T) {
179+
addr := setupRemotePluginServer()
180+
defer teardownRemotePluginServer()
181+
182+
m := Manifest{[]string{"VolumeDriver", "NetworkDriver"}}
183+
var output Manifest
184+
185+
mux.HandleFunc("/Test.Echo", func(w http.ResponseWriter, r *http.Request) {
186+
if r.Method != "POST" {
187+
t.Fatalf("Expected POST, got %s", r.Method)
188+
}
189+
190+
header := w.Header()
191+
header.Set("Content-Type", transport.VersionMimetype)
192+
193+
io.Copy(w, r.Body)
194+
})
195+
196+
c, _ := NewClient(addr, &tlsconfig.Options{InsecureSkipVerify: true})
197+
body, err := c.Stream("Test.Echo", m)
198+
if err != nil {
199+
t.Fatal(err)
200+
}
201+
defer body.Close()
202+
if err := json.NewDecoder(body).Decode(&output); err != nil {
203+
t.Fatalf("Test.Echo: error reading plugin resp: %v", err)
204+
}
205+
assert.Equal(t, m, output)
206+
}
207+
208+
func TestClientSendFile(t *testing.T) {
209+
addr := setupRemotePluginServer()
210+
defer teardownRemotePluginServer()
211+
212+
m := Manifest{[]string{"VolumeDriver", "NetworkDriver"}}
213+
var output Manifest
214+
var buf bytes.Buffer
215+
if err := json.NewEncoder(&buf).Encode(m); err != nil {
216+
t.Fatal(err)
217+
}
218+
mux.HandleFunc("/Test.Echo", func(w http.ResponseWriter, r *http.Request) {
219+
if r.Method != "POST" {
220+
t.Fatalf("Expected POST, got %s\n", r.Method)
221+
}
222+
223+
header := w.Header()
224+
header.Set("Content-Type", transport.VersionMimetype)
225+
226+
io.Copy(w, r.Body)
227+
})
228+
229+
c, _ := NewClient(addr, &tlsconfig.Options{InsecureSkipVerify: true})
230+
if err := c.SendFile("Test.Echo", &buf, &output); err != nil {
231+
t.Fatal(err)
232+
}
233+
assert.Equal(t, m, output)
234+
}

‎pkg/plugins/discovery_unix_test.go‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ package plugins
44

55
import (
66
"fmt"
7+
"io/ioutil"
78
"net"
89
"os"
910
"path/filepath"
@@ -59,3 +60,41 @@ func TestLocalSocket(t *testing.T) {
5960
l.Close()
6061
}
6162
}
63+
64+
func TestScan(t *testing.T) {
65+
tmpdir, unregister := Setup(t)
66+
defer unregister()
67+
68+
pluginNames, err := Scan()
69+
if err != nil {
70+
t.Fatal(err)
71+
}
72+
if pluginNames != nil {
73+
t.Fatal("Plugin names should be empty.")
74+
}
75+
76+
path := filepath.Join(tmpdir, "echo.spec")
77+
addr := "unix://var/lib/docker/plugins/echo.sock"
78+
name := "echo"
79+
80+
err = os.MkdirAll(filepath.Dir(path), 0755)
81+
if err != nil {
82+
t.Fatal(err)
83+
}
84+
85+
err = ioutil.WriteFile(path, []byte(addr), 0644)
86+
if err != nil {
87+
t.Fatal(err)
88+
}
89+
90+
r := newLocalRegistry()
91+
p, err := r.Plugin(name)
92+
93+
pluginNamesNotEmpty, err := Scan()
94+
if err != nil {
95+
t.Fatal(err)
96+
}
97+
if p.Name() != pluginNamesNotEmpty[0] {
98+
t.Fatalf("Unable to scan plugin with name %s", p.name)
99+
}
100+
}

‎pkg/plugins/plugin_test.go‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,26 @@
11
package plugins
22

33
import (
4+
"bytes"
5+
"encoding/json"
46
"errors"
7+
"io"
8+
"io/ioutil"
9+
"net/http"
510
"path/filepath"
611
"runtime"
712
"sync"
813
"testing"
914
"time"
15+
16+
"github.com/docker/docker/pkg/plugins/transport"
17+
"github.com/docker/go-connections/tlsconfig"
18+
"github.com/stretchr/testify/assert"
19+
)
20+
21+
const (
22+
fruitPlugin = "fruit"
23+
fruitImplements = "apple"
1024
)
1125

1226
// regression test for deadlock in handlers
@@ -42,3 +56,101 @@ func testActive(t *testing.T, p *Plugin) {
4256
}
4357

4458
}
59+
60+
func TestGet(t *testing.T) {
61+
p := &Plugin{name: fruitPlugin, activateWait: sync.NewCond(&sync.Mutex{})}
62+
p.Manifest = &Manifest{Implements: []string{fruitImplements}}
63+
storage.plugins[fruitPlugin] = p
64+
65+
plugin, err := Get(fruitPlugin, fruitImplements)
66+
if err != nil {
67+
t.Fatal(err)
68+
}
69+
if p.Name() != plugin.Name() {
70+
t.Fatalf("No matching plugin with name %s found", plugin.Name())
71+
}
72+
if plugin.Client() != nil {
73+
t.Fatal("expected nil Client but found one")
74+
}
75+
if !plugin.IsV1() {
76+
t.Fatal("Expected true for V1 plugin")
77+
}
78+
79+
// check negative case where plugin fruit doesn't implement banana
80+
_, err = Get("fruit", "banana")
81+
assert.Equal(t, err, ErrNotImplements)
82+
83+
// check negative case where plugin vegetable doesn't exist
84+
_, err = Get("vegetable", "potato")
85+
assert.Equal(t, err, ErrNotFound)
86+
87+
}
88+
89+
func TestPluginWithNoManifest(t *testing.T) {
90+
addr := setupRemotePluginServer()
91+
defer teardownRemotePluginServer()
92+
93+
m := Manifest{[]string{fruitImplements}}
94+
var buf bytes.Buffer
95+
if err := json.NewEncoder(&buf).Encode(m); err != nil {
96+
t.Fatal(err)
97+
}
98+
99+
mux.HandleFunc("/Plugin.Activate", func(w http.ResponseWriter, r *http.Request) {
100+
if r.Method != "POST" {
101+
t.Fatalf("Expected POST, got %s\n", r.Method)
102+
}
103+
104+
header := w.Header()
105+
header.Set("Content-Type", transport.VersionMimetype)
106+
107+
io.Copy(w, &buf)
108+
})
109+
110+
p := &Plugin{
111+
name: fruitPlugin,
112+
activateWait: sync.NewCond(&sync.Mutex{}),
113+
Addr: addr,
114+
TLSConfig: &tlsconfig.Options{InsecureSkipVerify: true},
115+
}
116+
storage.plugins[fruitPlugin] = p
117+
118+
plugin, err := Get(fruitPlugin, fruitImplements)
119+
if err != nil {
120+
t.Fatal(err)
121+
}
122+
if p.Name() != plugin.Name() {
123+
t.Fatalf("No matching plugin with name %s found", plugin.Name())
124+
}
125+
}
126+
127+
func TestGetAll(t *testing.T) {
128+
tmpdir, unregister := Setup(t)
129+
defer unregister()
130+
131+
p := filepath.Join(tmpdir, "example.json")
132+
spec := `{
133+
"Name": "example",
134+
"Addr": "https://example.com/docker/plugin"
135+
}`
136+
137+
if err := ioutil.WriteFile(p, []byte(spec), 0644); err != nil {
138+
t.Fatal(err)
139+
}
140+
141+
r := newLocalRegistry()
142+
plugin, err := r.Plugin("example")
143+
if err != nil {
144+
t.Fatal(err)
145+
}
146+
plugin.Manifest = &Manifest{Implements: []string{"apple"}}
147+
storage.plugins["example"] = plugin
148+
149+
fetchedPlugins, err := GetAll("apple")
150+
if err != nil {
151+
t.Fatal(err)
152+
}
153+
if fetchedPlugins[0].Name() != plugin.Name() {
154+
t.Fatalf("Expected to get plugin with name %s", plugin.Name())
155+
}
156+
}

‎pkg/plugins/transport/http_test.go‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
package transport
2+
3+
import (
4+
"io"
5+
"net/http"
6+
"testing"
7+
8+
"github.com/stretchr/testify/assert"
9+
)
10+
11+
func TestHTTPTransport(t *testing.T) {
12+
var r io.Reader
13+
roundTripper := &http.Transport{}
14+
newTransport := NewHTTPTransport(roundTripper, "http", "0.0.0.0")
15+
request, err := newTransport.NewRequest("", r)
16+
if err != nil {
17+
t.Fatal(err)
18+
}
19+
assert.Equal(t, "POST", request.Method)
20+
}

‎plugin/manager_linux.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ func (pm *Manager) enable(p *v2.Plugin, c *controller, force bool) error {
8080

8181
func (pm *Manager) pluginPostStart(p *v2.Plugin, c *controller) error {
8282
sockAddr := filepath.Join(pm.config.ExecRoot, p.GetID(), p.GetSocket())
83-
client, err := plugins.NewClientWithTimeout("unix://"+sockAddr, nil, c.timeoutInSecs)
83+
client, err := plugins.NewClientWithTimeout("unix://"+sockAddr, nil, time.Duration(c.timeoutInSecs)*time.Second)
8484
if err != nil {
8585
c.restart = false
8686
shutdownPlugin(p, c, pm.containerdClient)

0 commit comments

Comments
 (0)