Merge lp:~mattyw/sharinfoo/tests-and-client-refactoring into lp:sharinfoo

[Matthew Williams]

Refactored the client to allow unit tests to be written.
Added a python test which tests the actual client binary.
Added a makefile to run the tests

Refactored the client to allow unit tests to be written.
Added a python test which tests the actual client binary.
Added a makefile to run the tests

After this change I can start refactoring the server without fearing breaking the client

[lp:~mattyw/sharinfoo/tests-and-client-refactoring]

19. By Matthew Williams on 2014-01-10

make the python file cleaner

=== added file 'Makefile'
--- Makefile	1970-01-01 00:00:00 +0000
+++ Makefile	2014-01-10 12:43:25 +0000
@@ -0,0 +1,8 @@
+check: install
+	shfood &
+	go test ./...
+	python ./tests/client_test.py
+	killall shfood
+
+install:
+	go install ./...

=== added directory 'client'
=== added file 'client/client.go'
--- client/client.go	1970-01-01 00:00:00 +0000
+++ client/client.go	2014-01-10 12:43:25 +0000
@@ -0,0 +1,205 @@
+package client
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+	"io/ioutil"
+	"net/http"
+	"net/url"
+	"os"
+	"path"
+	"strings"
+
+	"code.google.com/p/gopass"
+	"launchpad.net/usso"
+)
+
+type ClosingBuffer struct {
+	*bytes.Buffer
+}
+
+func (cb *ClosingBuffer) Close() error {
+	return nil
+}
+
+func Login(user string) error {
+	ssoData, err := SSOLogin(user)
+	if err != nil {
+		return err
+	}
+	f, err := os.Create(path.Join(os.Getenv("HOME"), ".shfoo_auth"))
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+	_, err = fmt.Fprintf(f, "ConsumerKey=%s, ConsumerSecret=%s, "+
+		"TokenKey=%s, TokenName=%s, TokenSecret=%s",
+		ssoData.ConsumerKey, ssoData.ConsumerSecret, ssoData.TokenKey,
+		ssoData.TokenName, ssoData.TokenSecret)
+	return err
+}
+
+// Perform a Ubuntu SSO login with the provided email
+func SSOLogin(email string) (*usso.SSOData, error) {
+	pass, err := gopass.GetPass("Password: ")
+	if err != nil {
+		return nil, err
+	}
+
+	ssoData, err := usso.ProductionUbuntuSSOServer.GetToken(email, pass, "sharinfoo")
+	if err != nil {
+		return nil, err
+	}
+
+	return ssoData, nil
+}
+
+func loadAuth() (string, error) {
+	f, err := os.Open(path.Join(os.Getenv("HOME"), ".shfoo_auth"))
+	if err != nil {
+		return "", err
+	}
+	buf, err := ioutil.ReadAll(f)
+	if err != nil {
+		return "", err
+	}
+	return string(buf), nil
+}
+
+func Delete(addr, path string) error {
+	authString, err := loadAuth()
+	if err != nil {
+		return err
+	}
+	u := url.URL{
+		Scheme: "http",
+		Host:   addr,
+		Path:   path,
+	}
+	req, err := http.NewRequest("DELETE", u.String(), nil)
+	if err != nil {
+		return err
+	}
+	req.Header.Add("Authorization", authString)
+	resp, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return err
+	}
+	if resp.StatusCode != 200 {
+		return fmt.Errorf(resp.Status)
+	}
+	_, err = io.Copy(os.Stdout, resp.Body)
+	return err
+}
+
+func Put(addr, path string, data []byte) error {
+	authString, err := loadAuth()
+	if err != nil {
+		return err
+	}
+	u := url.URL{
+		Scheme: "http",
+		Host:   addr,
+		Path:   path,
+	}
+	req, err := http.NewRequest("PUT", u.String(), nil)
+	if err != nil {
+		return err
+	}
+	req.Header.Add("Authorization", authString)
+	req.Body = &ClosingBuffer{bytes.NewBuffer(data)}
+	resp, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return err
+	}
+	if resp.StatusCode != 200 {
+		return fmt.Errorf(resp.Status)
+	}
+	_, err = io.Copy(os.Stdout, resp.Body)
+	return err
+}
+
+func Get(addr, path string) ([]byte, error) {
+	authString, err := loadAuth()
+	if err != nil {
+		return nil, err
+	}
+	u := url.URL{
+		Scheme: "http",
+		Host:   addr,
+		Path:   path,
+	}
+	req, err := http.NewRequest("GET", u.String(), nil)
+	if err != nil {
+		return nil, err
+	}
+	req.Header.Add("Authorization", authString)
+	resp, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return nil, err
+	}
+	if resp.StatusCode != 200 {
+		return nil, fmt.Errorf(resp.Status)
+	}
+	return ioutil.ReadAll(resp.Body)
+}
+
+func Access(addr, path string) ([]byte, error) {
+	authString, err := loadAuth()
+	if err != nil {
+		return nil, err
+	}
+	query := url.Values{}
+	query.Add("meta", "1")
+
+	u := url.URL{
+		Scheme:   "http",
+		Host:     addr,
+		Path:     path,
+		RawQuery: query.Encode(),
+	}
+	req, err := http.NewRequest("GET", u.String(), nil)
+	if err != nil {
+		return nil, err
+	}
+	req.Header.Add("Authorization", authString)
+	resp, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return nil, err
+	}
+	if resp.StatusCode != 200 {
+		return nil, fmt.Errorf(resp.Status)
+	}
+	return ioutil.ReadAll(resp.Body)
+}
+
+func Share(addr, path, with string) error {
+	authString, err := loadAuth()
+	if err != nil {
+		return err
+	}
+	u := url.URL{
+		Scheme: "http",
+		Host:   addr,
+		Path:   path,
+	}
+	req, err := http.NewRequest("PUT", u.String(), strings.NewReader(url.Values{
+		"meta":   []string{"1"},
+		"reader": []string{with}}.Encode()))
+	if err != nil {
+		return err
+	}
+	req.Header.Add("Authorization", authString)
+	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
+	resp, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return err
+	}
+	if resp.StatusCode != 200 {
+		return fmt.Errorf(resp.Status)
+	}
+	_, err = io.Copy(os.Stdout, resp.Body)
+	return err
+	panic("no impl")
+}

=== added file 'client/client_test.go'
--- client/client_test.go	1970-01-01 00:00:00 +0000
+++ client/client_test.go	2014-01-10 12:43:25 +0000
@@ -0,0 +1,45 @@
+package client
+
+import (
+	"encoding/json"
+	. "launchpad.net/gocheck"
+	"testing"
+)
+
+func Test(t *testing.T) { TestingT(t) }
+
+var addr = "localhost:8080"
+
+type ClientSuite struct{}
+
+var _ = Suite(&ClientSuite{})
+
+func (s *ClientSuite) TestPutGet(c *C) {
+	data := []byte("hello there")
+	path := "/test-data"
+	err := Put(addr, path, data)
+	c.Assert(err, IsNil)
+	result, err := Get(addr, path)
+	c.Assert(err, IsNil)
+	c.Assert(result, DeepEquals, data)
+	err = Delete(addr, path)
+	c.Assert(err, IsNil)
+}
+
+func (s *ClientSuite) TestShareAndAccess(c *C) {
+	output := []map[string]bool{}
+	shareWith := "[e-mail]"
+	data := []byte("hello there")
+	path := "/test-share"
+	err := Put(addr, path, data)
+	c.Assert(err, IsNil)
+	err = Share(addr, path, shareWith)
+	c.Assert(err, IsNil)
+	owners, err := Access(addr, path)
+	err = json.Unmarshal(owners, &output)
+	c.Assert(err, IsNil)
+	c.Assert(output[1], DeepEquals, map[string]bool{shareWith: true})
+
+	err = Delete(addr, path)
+	c.Assert(err, IsNil)
+}

=== modified file 'cmd/shfoo/main.go'
--- cmd/shfoo/main.go	2014-01-10 12:43:25 +0000
+++ cmd/shfoo/main.go	2014-01-10 12:43:25 +0000
@@ -19,17 +19,11 @@
 import (
 	"flag"
 	"fmt"
-	"io"
 	"io/ioutil"
 	"log"
-	"net/http"
-	"net/url"
 	"os"
-	"path"
-	"strings"
 
-	"code.google.com/p/gopass"
-	"launchpad.net/usso"
+	"launchpad.net/sharinfoo/client"
 )
 
 var login *string = flag.String("login", "", "Login user account")
@@ -45,207 +39,35 @@
 	log.Println(err)
 }
 
-// Perform a Ubuntu SSO login with the provided email
-func SSOLogin(email string) (*usso.SSOData, error) {
-	pass, err := gopass.GetPass("Password: ")
-	if err != nil {
-		return nil, err
-	}
-
-	ssoData, err := usso.ProductionUbuntuSSOServer.GetToken(email, pass, "sharinfoo")
-	if err != nil {
-		return nil, err
-	}
-
-	return ssoData, nil
-}
-
-func Login() error {
-	ssoData, err := SSOLogin(*login)
-	if err != nil {
-		return err
-	}
-	f, err := os.Create(path.Join(os.Getenv("HOME"), ".shfoo_auth"))
-	if err != nil {
-		return err
-	}
-	defer f.Close()
-	_, err = fmt.Fprintf(f, "ConsumerKey=%s, ConsumerSecret=%s, "+
-		"TokenKey=%s, TokenName=%s, TokenSecret=%s",
-		ssoData.ConsumerKey, ssoData.ConsumerSecret, ssoData.TokenKey,
-		ssoData.TokenName, ssoData.TokenSecret)
-	return err
-}
-
-func loadAuth() (string, error) {
-	f, err := os.Open(path.Join(os.Getenv("HOME"), ".shfoo_auth"))
-	if err != nil {
-		return "", err
-	}
-	buf, err := ioutil.ReadAll(f)
-	if err != nil {
-		return "", err
-	}
-	return string(buf), nil
-}
-
-func Delete() error {
-	authString, err := loadAuth()
-	if err != nil {
-		return err
-	}
-	u := url.URL{
-		Scheme: "http",
-		Host:   *addr,
-		Path:   *del,
-	}
-	req, err := http.NewRequest("DELETE", u.String(), nil)
-	if err != nil {
-		return err
-	}
-	req.Header.Add("Authorization", authString)
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	if resp.StatusCode != 200 {
-		return fmt.Errorf(resp.Status)
-	}
-	_, err = io.Copy(os.Stdout, resp.Body)
-	return err
-}
-
-func Put() error {
-	authString, err := loadAuth()
-	if err != nil {
-		return err
-	}
-	u := url.URL{
-		Scheme: "http",
-		Host:   *addr,
-		Path:   *put,
-	}
-	req, err := http.NewRequest("PUT", u.String(), nil)
-	if err != nil {
-		return err
-	}
-	req.Header.Add("Authorization", authString)
-	req.Body = os.Stdin
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	if resp.StatusCode != 200 {
-		return fmt.Errorf(resp.Status)
-	}
-	_, err = io.Copy(os.Stdout, resp.Body)
-	return err
-}
-
-func Get() error {
-	authString, err := loadAuth()
-	if err != nil {
-		return err
-	}
-	u := url.URL{
-		Scheme: "http",
-		Host:   *addr,
-		Path:   *get,
-	}
-	req, err := http.NewRequest("GET", u.String(), nil)
-	if err != nil {
-		return err
-	}
-	req.Header.Add("Authorization", authString)
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	if resp.StatusCode != 200 {
-		return fmt.Errorf(resp.Status)
-	}
-	_, err = io.Copy(os.Stdout, resp.Body)
-	return err
-}
-
-func Access() error {
-	authString, err := loadAuth()
-	if err != nil {
-		return err
-	}
-	query := url.Values{}
-	query.Add("meta", "1")
-
-	u := url.URL{
-		Scheme:   "http",
-		Host:     *addr,
-		Path:     *access,
-		RawQuery: query.Encode(),
-	}
-	req, err := http.NewRequest("GET", u.String(), nil)
-	if err != nil {
-		return err
-	}
-	req.Header.Add("Authorization", authString)
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	if resp.StatusCode != 200 {
-		return fmt.Errorf(resp.Status)
-	}
-	_, err = io.Copy(os.Stdout, resp.Body)
-	fmt.Printf("\n")
-	return err
-	panic("no impl")
-}
-
-func Share() error {
-	authString, err := loadAuth()
-	if err != nil {
-		return err
-	}
-	u := url.URL{
-		Scheme: "http",
-		Host:   *addr,
-		Path:   *share,
-	}
-	req, err := http.NewRequest("PUT", u.String(), strings.NewReader(url.Values{
-		"meta":   []string{"1"},
-		"reader": []string{*with}}.Encode()))
-	if err != nil {
-		return err
-	}
-	req.Header.Add("Authorization", authString)
-	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return err
-	}
-	if resp.StatusCode != 200 {
-		return fmt.Errorf(resp.Status)
-	}
-	_, err = io.Copy(os.Stdout, resp.Body)
-	return err
-	panic("no impl")
-}
-
 func main() {
 	flag.Parse()
 	var err error
 	switch {
 	case *login != "":
-		err = Login()
+		err = client.Login(*login)
 	case *del != "":
-		err = Delete()
+		err = client.Delete(*addr, *del)
 	case *put != "":
-		err = Put()
+		data, err := ioutil.ReadAll(os.Stdin)
+		if err != nil {
+			log.Fatal(err)
+		}
+		err = client.Put(*addr, *put, data)
 	case *get != "":
-		err = Get()
+		output, err := client.Get(*addr, *get)
+		if err != nil {
+			die(err)
+		}
+		os.Stdout.Write(output)
 	case *share != "" && *with != "":
-		err = Share()
+		err = client.Share(*addr, *share, *with)
 	case *access != "":
-		err = Access()
+		output, err := client.Access(*addr, *access)
+		if err != nil {
+			die(err)
+		}
+		os.Stdout.Write(output)
+		fmt.Println("")
 	default:
 		err = fmt.Errorf("No action specified")
 	}

=== modified file 'server.go'
--- server.go	2014-01-10 12:43:25 +0000
+++ server.go	2014-01-10 12:43:25 +0000
@@ -59,7 +59,7 @@
 		return
 	}
 	req.ParseForm()
-	if req.Form.Get("meta") == "1" || query["meta"][0] == "1" {
+	if req.Form.Get("meta") == "1" || len(query) == 1 && query["meta"][0] == "1" {
 		fs.handleMetadata(w, req)
 	} else {
 		fs.handleContent(w, req)

=== added directory 'tests'
=== added file 'tests/client_test.py'
--- tests/client_test.py	1970-01-01 00:00:00 +0000
+++ tests/client_test.py	2014-01-10 12:43:25 +0000
@@ -0,0 +1,71 @@
+import subprocess
+import os
+import os.path
+import sys
+import json
+import unittest
+
+sample_data = "sample.txt"
+test_data = "test.txt"
+temporary_files = [sample_data, test_data]
+
+
+def put_command(src_file, dst_path):
+    out = subprocess.Popen(["cat", src_file], stdout=subprocess.PIPE)
+    return subprocess.check_call(["shfoo", "-put", "/%s" % dst_path],
+            stdin=out.stdout)
+
+
+def get_command(dst_file, src_path):
+    get = subprocess.Popen(["shfoo", "-get", "/%s" % src_path],
+            stdout=subprocess.PIPE)
+    with open(dst_file, "w") as f:
+        for line in get.stdout:
+            f.write(line)
+
+
+def share_command(path, share):
+    subprocess.check_call(["shfoo", "-share", "/%s" % path, "-with", share])
+
+
+def delete_command(path):
+    subprocess.check_call(["shfoo", "-delete", "/%s" % path])
+
+
+def access_command(path):
+    out = subprocess.Popen(["shfoo", "-access", "/%s" % path],
+            stdout=subprocess.PIPE)
+    return json.loads(out.stdout.read())
+
+
+def delete_temp_files():
+    for f in temporary_files:
+        if os.path.exists(f):
+            os.remove(f)
+
+
+class ClientTest(unittest.TestCase):
+
+    def setUp(self):
+        print "puttting test file"
+        with open(sample_data, "w") as srcFile:
+            srcFile.write("Line one\nLine two\n")
+        put_command(sample_data, test_data)
+
+    def tearDown(self):
+        delete_temp_files()
+        print "deleting test file"
+        delete_command(test_data)
+
+    def test_put_and_get(self):
+        get_command(test_data, test_data)
+        print "comparing"
+        self.assertEquals(open(test_data).read(), open(sample_data).read())
+
+    def test_share_and_acess(self):
+        share_command(test_data, "[e-mail]")
+        out = access_command(test_data)
+        self.assertEquals(out[1]["[e-mail]"], True)
+
+if __name__ == '__main__':
+    unittest.main()