Extract TestSuite out into its own package to close revel#737

anonx · anonx · commit 311cff9c277e · 2014-11-18T20:29:58.000+06:00
diff --git a/session.go b/session.go
@@ -66,8 +66,8 @@ func (s Session) getExpiration() time.Time {
 	return time.Now().Add(expireAfterDuration)
 }
 
-// cookie returns an http.Cookie containing the signed session.
-func (s Session) cookie() *http.Cookie {
+// Cookie returns an http.Cookie containing the signed session.
+func (s Session) Cookie() *http.Cookie {
 	var sessionValue string
 	ts := s.getExpiration()
 	s[TIMESTAMP_KEY] = getSessionExpirationCookie(ts)
@@ -106,9 +106,9 @@ func sessionTimeoutExpiredOrMissing(session Session) bool {
 	return false
 }
 
-// getSessionFromCookie returns a Session struct pulled from the signed
+// GetSessionFromCookie returns a Session struct pulled from the signed
 // session cookie.
-func getSessionFromCookie(cookie *http.Cookie) Session {
+func GetSessionFromCookie(cookie *http.Cookie) Session {
 	session := make(Session)
 
 	// Separate the data from the signature.
@@ -149,7 +149,7 @@ func SessionFilter(c *Controller, fc []Filter) {
 
 	// Store the signed session if it could have changed.
 	if len(c.Session) > 0 || !sessionWasEmpty {
-		c.SetCookie(c.Session.cookie())
+		c.SetCookie(c.Session.Cookie())
 	}
 }
 
@@ -160,7 +160,7 @@ func restoreSession(req *http.Request) Session {
 	if err != nil {
 		return make(Session)
 	} else {
-		return getSessionFromCookie(cookie)
+		return GetSessionFromCookie(cookie)
 	}
 }
 
diff --git a/session_test.go b/session_test.go
@@ -11,12 +11,12 @@ func TestSessionRestore(t *testing.T) {
 	originSession := make(Session)
 	originSession["foo"] = "foo"
 	originSession["bar"] = "bar"
-	cookie := originSession.cookie()
+	cookie := originSession.Cookie()
 	if !cookie.Expires.IsZero() {
 		t.Error("incorrect cookie expire", cookie.Expires)
 	}
 
-	restoredSession := getSessionFromCookie(cookie)
+	restoredSession := GetSessionFromCookie(cookie)
 	for k, v := range originSession {
 		if restoredSession[k] != v {
 			t.Errorf("session restore failed session[%s] != %s", k, v)
@@ -30,9 +30,9 @@ func TestSessionExpire(t *testing.T) {
 	session["user"] = "Tom"
 	var cookie *http.Cookie
 	for i := 0; i < 3; i++ {
-		cookie = session.cookie()
+		cookie = session.Cookie()
 		time.Sleep(time.Second)
-		session = getSessionFromCookie(cookie)
+		session = GetSessionFromCookie(cookie)
 	}
 	expectExpire := time.Now().Add(expireAfterDuration)
 	if cookie.Expires.Unix() < expectExpire.Add(-time.Second).Unix() {
@@ -44,16 +44,16 @@ func TestSessionExpire(t *testing.T) {
 
 	session.SetNoExpiration()
 	for i := 0; i < 3; i++ {
-		cookie = session.cookie()
-		session = getSessionFromCookie(cookie)
+		cookie = session.Cookie()
+		session = GetSessionFromCookie(cookie)
 	}
-	cookie = session.cookie()
+	cookie = session.Cookie()
 	if !cookie.Expires.IsZero() {
 		t.Error("expect cookie expires is zero")
 	}
 
 	session.SetDefaultExpiration()
-	cookie = session.cookie()
+	cookie = session.Cookie()
 	expectExpire = time.Now().Add(expireAfterDuration)
 	if cookie.Expires.Unix() < expectExpire.Add(-time.Second).Unix() {
 		t.Error("expect expires", cookie.Expires, "after", expectExpire.Add(-time.Second))
diff --git a/skeleton/tests/apptest.go b/skeleton/tests/apptest.go
@@ -1,9 +1,9 @@
 package tests
 
-import "github.com/revel/revel"
+import "github.com/revel/revel/testing"
 
 type AppTest struct {
-	revel.TestSuite
+	testing.TestSuite
 }
 
 func (t *AppTest) Before() {
diff --git a/testing/testsuite.go b/testing/testsuite.go
@@ -1,4 +1,4 @@
-package revel
+package testing
 
 import (
 	"bytes"
@@ -16,14 +16,16 @@ import (
 	"regexp"
 	"strings"
 
+	"github.com/revel/revel"
+
 	"golang.org/x/net/websocket"
 )
 
 type TestSuite struct {
 	Client       *http.Client
 	Response     *http.Response
 	ResponseBody []byte
-	Session      Session
+	Session      revel.Session
 }
 
 type TestRequest struct {
@@ -39,22 +41,22 @@ func NewTestSuite() TestSuite {
 	jar, _ := cookiejar.New(nil)
 	return TestSuite{
 		Client:  &http.Client{Jar: jar},
-		Session: make(Session),
+		Session: make(revel.Session),
 	}
 }
 
 // Return the address and port of the server, e.g. "127.0.0.1:8557"
 func (t *TestSuite) Host() string {
-	if Server.Addr[0] == ':' {
-		return "127.0.0.1" + Server.Addr
+	if revel.Server.Addr[0] == ':' {
+		return "127.0.0.1" + revel.Server.Addr
 	}
-	return Server.Addr
+	return revel.Server.Addr
 }
 
 // Return the base http/https URL of the server, e.g. "http://127.0.0.1:8557".
 // The scheme is set to https if http.ssl is set to true in the configuration file.
 func (t *TestSuite) BaseUrl() string {
-	if HttpSsl {
+	if revel.HttpSsl {
 		return "https://" + t.Host()
 	} else {
 		return "http://" + t.Host()
@@ -208,7 +210,7 @@ func (t *TestSuite) PostFileCustom(uri string, params url.Values, filePaths url.
 // examine the Response and ResponseBody properties. Session data will be
 // added to the request cookies for you.
 func (r *TestRequest) Send() {
-	r.AddCookie(r.testSuite.Session.cookie())
+	r.AddCookie(r.testSuite.Session.Cookie())
 	r.MakeRequest()
 }
 
@@ -225,10 +227,10 @@ func (r *TestRequest) MakeRequest() {
 	}
 
 	// Look for a session cookie in the response and parse it.
-	sessionCookieName := r.testSuite.Session.cookie().Name
+	sessionCookieName := r.testSuite.Session.Cookie().Name
 	for _, cookie := range r.testSuite.Client.Jar.Cookies(r.Request.URL) {
 		if cookie.Name == sessionCookieName {
-			r.testSuite.Session = getSessionFromCookie(cookie)
+			r.testSuite.Session = revel.GetSessionFromCookie(cookie)
 			break
 		}
 	}
@@ -271,13 +273,13 @@ func (t *TestSuite) AssertHeader(name, value string) {
 }
 
 func (t *TestSuite) AssertEqual(expected, actual interface{}) {
-	if !Equal(expected, actual) {
+	if !revel.Equal(expected, actual) {
 		panic(fmt.Errorf("(expected) %v != %v (actual)", expected, actual))
 	}
 }
 
 func (t *TestSuite) AssertNotEqual(expected, actual interface{}) {
-	if Equal(expected, actual) {
+	if revel.Equal(expected, actual) {
 		panic(fmt.Errorf("(expected) %v == %v (actual)", expected, actual))
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -66,8 +66,8 @@ func (s Session) getExpiration() time.Time {`
`66`	`66`	`return time.Now().Add(expireAfterDuration)`
`67`	`67`	`}`
`68`	`68`
`69`		`-// cookie returns an http.Cookie containing the signed session.`
`70`		`-func (s Session) cookie() *http.Cookie {`
	`69`	`+// Cookie returns an http.Cookie containing the signed session.`
	`70`	`+func (s Session) Cookie() *http.Cookie {`
`71`	`71`	`var sessionValue string`
`72`	`72`	`ts := s.getExpiration()`
`73`	`73`	`s[TIMESTAMP_KEY] = getSessionExpirationCookie(ts)`
`@@ -106,9 +106,9 @@ func sessionTimeoutExpiredOrMissing(session Session) bool {`
`106`	`106`	`return false`
`107`	`107`	`}`
`108`	`108`
`109`		`-// getSessionFromCookie returns a Session struct pulled from the signed`
	`109`	`+// GetSessionFromCookie returns a Session struct pulled from the signed`
`110`	`110`	`// session cookie.`
`111`		`-func getSessionFromCookie(cookie *http.Cookie) Session {`
	`111`	`+func GetSessionFromCookie(cookie *http.Cookie) Session {`
`112`	`112`	`session := make(Session)`
`113`	`113`
`114`	`114`	`// Separate the data from the signature.`
`@@ -149,7 +149,7 @@ func SessionFilter(c *Controller, fc []Filter) {`
`149`	`149`
`150`	`150`	`// Store the signed session if it could have changed.`
`151`	`151`	`if len(c.Session) > 0 \|\| !sessionWasEmpty {`
`152`		`- c.SetCookie(c.Session.cookie())`
	`152`	`+ c.SetCookie(c.Session.Cookie())`
`153`	`153`	`}`
`154`	`154`	`}`
`155`	`155`
`@@ -160,7 +160,7 @@ func restoreSession(req *http.Request) Session {`
`160`	`160`	`if err != nil {`
`161`	`161`	`return make(Session)`
`162`	`162`	`} else {`
`163`		`- return getSessionFromCookie(cookie)`
	`163`	`+ return GetSessionFromCookie(cookie)`
`164`	`164`	`}`
`165`	`165`	`}`
`166`	`166`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`package tests`
`2`	`2`
`3`		`-import "github.com/revel/revel"`
	`3`	`+import "github.com/revel/revel/testing"`
`4`	`4`
`5`	`5`	`type AppTest struct {`
`6`		`- revel.TestSuite`
	`6`	`+ testing.TestSuite`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`func (t *AppTest) Before() {`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package revel`
	`1`	`+package testing`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"bytes"`
`@@ -16,14 +16,16 @@ import (`
`16`	`16`	`"regexp"`
`17`	`17`	`"strings"`
`18`	`18`
	`19`	`+ "github.com/revel/revel"`
	`20`	`+`
`19`	`21`	`"golang.org/x/net/websocket"`
`20`	`22`	`)`
`21`	`23`
`22`	`24`	`type TestSuite struct {`
`23`	`25`	`Client *http.Client`
`24`	`26`	`Response *http.Response`
`25`	`27`	`ResponseBody []byte`
`26`		`- Session Session`
	`28`	`+ Session revel.Session`
`27`	`29`	`}`
`28`	`30`
`29`	`31`	`type TestRequest struct {`
`@@ -39,22 +41,22 @@ func NewTestSuite() TestSuite {`
`39`	`41`	`jar, _ := cookiejar.New(nil)`
`40`	`42`	`return TestSuite{`
`41`	`43`	`Client: &http.Client{Jar: jar},`
`42`		`- Session: make(Session),`
	`44`	`+ Session: make(revel.Session),`
`43`	`45`	`}`
`44`	`46`	`}`
`45`	`47`
`46`	`48`	`// Return the address and port of the server, e.g. "127.0.0.1:8557"`
`47`	`49`	`func (t *TestSuite) Host() string {`
`48`		`- if Server.Addr[0] == ':' {`
`49`		`- return "127.0.0.1" + Server.Addr`
	`50`	`+ if revel.Server.Addr[0] == ':' {`
	`51`	`+ return "127.0.0.1" + revel.Server.Addr`
`50`	`52`	`}`
`51`		`- return Server.Addr`
	`53`	`+ return revel.Server.Addr`
`52`	`54`	`}`
`53`	`55`
`54`	`56`	`// Return the base http/https URL of the server, e.g. "http://127.0.0.1:8557".`
`55`	`57`	`// The scheme is set to https if http.ssl is set to true in the configuration file.`
`56`	`58`	`func (t *TestSuite) BaseUrl() string {`
`57`		`- if HttpSsl {`
	`59`	`+ if revel.HttpSsl {`
`58`	`60`	`return "https://" + t.Host()`
`59`	`61`	`} else {`
`60`	`62`	`return "http://" + t.Host()`
`@@ -208,7 +210,7 @@ func (t *TestSuite) PostFileCustom(uri string, params url.Values, filePaths url.`
`208`	`210`	`// examine the Response and ResponseBody properties. Session data will be`
`209`	`211`	`// added to the request cookies for you.`
`210`	`212`	`func (r *TestRequest) Send() {`
`211`		`- r.AddCookie(r.testSuite.Session.cookie())`
	`213`	`+ r.AddCookie(r.testSuite.Session.Cookie())`
`212`	`214`	`r.MakeRequest()`
`213`	`215`	`}`
`214`	`216`
`@@ -225,10 +227,10 @@ func (r *TestRequest) MakeRequest() {`
`225`	`227`	`}`
`226`	`228`
`227`	`229`	`// Look for a session cookie in the response and parse it.`
`228`		`- sessionCookieName := r.testSuite.Session.cookie().Name`
	`230`	`+ sessionCookieName := r.testSuite.Session.Cookie().Name`
`229`	`231`	`for _, cookie := range r.testSuite.Client.Jar.Cookies(r.Request.URL) {`
`230`	`232`	`if cookie.Name == sessionCookieName {`
`231`		`- r.testSuite.Session = getSessionFromCookie(cookie)`
	`233`	`+ r.testSuite.Session = revel.GetSessionFromCookie(cookie)`
`232`	`234`	`break`
`233`	`235`	`}`
`234`	`236`	`}`
`@@ -271,13 +273,13 @@ func (t *TestSuite) AssertHeader(name, value string) {`
`271`	`273`	`}`
`272`	`274`
`273`	`275`	`func (t *TestSuite) AssertEqual(expected, actual interface{}) {`
`274`		`- if !Equal(expected, actual) {`
	`276`	`+ if !revel.Equal(expected, actual) {`
`275`	`277`	`panic(fmt.Errorf("(expected) %v != %v (actual)", expected, actual))`
`276`	`278`	`}`
`277`	`279`	`}`
`278`	`280`
`279`	`281`	`func (t *TestSuite) AssertNotEqual(expected, actual interface{}) {`
`280`		`- if Equal(expected, actual) {`
	`282`	`+ if revel.Equal(expected, actual) {`
`281`	`283`	`panic(fmt.Errorf("(expected) %v == %v (actual)", expected, actual))`
`282`	`284`	`}`
`283`	`285`	`}`