Add open api tests (#122)

* Adds README under /openApiTests

Explaining intention of the folder

* Adds Open API test based on Prism

And instructions on how to run it locally

* Adds Github Actions workflow

To run Open API test as part of a CI process

* Run CI process every 5 minutes

As part of a "soak" test to confirm that the CI process is reliable

* Revert "Run CI process every 5 minutes"

This reverts commit 6babbb9.

* Remove CI using Github Actions

* Removes CI badge from README

* Merge OpenAPI tests with existing tests

* Use testify assert

Makes test easier to read

* Removes code no longer required

* Fixes typo

Author: ebh

Makefile

@@ -17,7 +17,10 @@ endif
 test: env ## run go test all
 	go test -v ./tests
 
+test/swagger:
+	env BITBUCKET_API_BASE_URL=http://0.0.0.0:4010 go test -v ./...
+
 help: ## print this help
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-.PHONY: test help
+.PHONY: test test/swagger help

client.go

@@ -23,6 +23,16 @@ import (
 
 const DEFAULT_PAGE_LENGTH = 10
 const DEFAULT_MAX_DEPTH = 1
+const DEFAULT_BITBUCKET_API_BASE_URL = "https://api.bitbucket.org/2.0"
+
+func apiBaseUrl() string {
+	ev := os.Getenv("BITBUCKET_API_BASE_URL")
+	if ev != "" {
+		return ev
+	}
+
+	return DEFAULT_BITBUCKET_API_BASE_URL
+}
 
 type Client struct {
 	Auth         *auth
@@ -125,7 +135,7 @@ func NewBasicAuth(u, p string) *Client {
 }
 
 func injectClient(a *auth) *Client {
-	c := &Client{Auth: a, Pagelen: DEFAULT_PAGE_LENGTH, MaxDepth: DEFAULT_MAX_DEPTH, apiBaseURL: "https://api.bitbucket.org/2.0"}
+	c := &Client{Auth: a, Pagelen: DEFAULT_PAGE_LENGTH, MaxDepth: DEFAULT_MAX_DEPTH, apiBaseURL: apiBaseUrl()}
 	c.Repositories = &Repositories{
 		c:                  c,
 		PullRequests:       &PullRequests{c: c},

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/mattn/go-colorable v0.0.9 // indirect
 	github.com/mattn/go-isatty v0.0.3 // indirect
 	github.com/mitchellh/mapstructure v0.0.0-20180220230111-00c29f56e238
+	github.com/stretchr/testify v1.6.1
 	golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01
 	golang.org/x/oauth2 v0.0.0-20180227000427-d7d64896b5ff
 	golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e // indirect

go.sum

@@ -1,3 +1,5 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/golang/protobuf v1.0.0 h1:lsek0oXi8iFE9L+EXARyHIjU5rlWIhhTkjDz3vHhWWQ=
 github.com/golang/protobuf v1.0.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/k0kubun/colorstring v0.0.0-20150214042306-9440f1994b88 h1:uC1QfSlInpQF+M0ao65imhwqKnz3Q2z/d8PWZRMQvDM=
@@ -10,6 +12,11 @@ github.com/mattn/go-isatty v0.0.3 h1:ns/ykhmWi7G9O+8a448SecJU3nSMBXJfqQkl0upE1jI
 github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
 github.com/mitchellh/mapstructure v0.0.0-20180220230111-00c29f56e238 h1:+MZW2uvHgN8kYvksEN3f7eFL2wpzk0GxmlFsMybWc7E=
 github.com/mitchellh/mapstructure v0.0.0-20180220230111-00c29f56e238/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
+github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01 h1:po1f06KS05FvIQQA2pMuOWZAUXiy1KYdIf0ElUU2Hhc=
 golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/oauth2 v0.0.0-20180227000427-d7d64896b5ff h1:WbI0V2v8RZPTlOMrecBqqba3029Z6l7jeFySSGaN/jk=
@@ -20,3 +27,6 @@ golang.org/x/sys v0.0.0-20180224232135-f6cff0780e54 h1:4qAtdeqGYyXU2CfUvLomEFw0c
 golang.org/x/sys v0.0.0-20180224232135-f6cff0780e54/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 google.golang.org/appengine v1.0.0 h1:dN4LljjBKVChsv0XCSI+zbyzdqrkEwX5LQFUMRSGqOc=
 google.golang.org/appengine v1.0.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

tests/README.md

@@ -0,0 +1,23 @@
+# Tests
+
+As per @ktrysmt's comment [here](https://github.com/ktrysmt/go-bitbucket/pull/122#issuecomment-758373984) tests are being changed so they can be run against both:
+1. The actual Bitbucket API
+1. The Swagger documentation from Bitbucket ([https://bitbucket.org/api/swagger.json](https://bitbucket.org/api/swagger.json)), using [Stoplight's Prism](https://stoplight.io/open-source/prism)
+
+The latter will eventually be run as part of a CI process using [Github Actions](https://github.com/features/actions).
+
+## Running tests locally against the Bitbucket API
+
+Please refer to [../README.md](../README.md).
+
+# Running test locally against Prism
+
+Run in a shell terminal:
+```
+docker run --rm -it -p 4010:4010 stoplight/prism:3 mock -h 0.0.0.0 https://bitbucket.org/api/swagger.json
+```
+
+Then in another shell terminal session run:
+```
+make test/swagger
+```

tests/user_test.go

@@ -1,6 +1,7 @@
 package tests
 
 import (
+	"github.com/stretchr/testify/assert"
 	"os"
 	"testing"
 
@@ -9,25 +10,31 @@ import (
 
 func TestProfile(t *testing.T) {
 
-	user := os.Getenv("BITBUCKET_TEST_USERNAME")
-	pass := os.Getenv("BITBUCKET_TEST_PASSWORD")
-
-	if user == "" {
-		t.Error("BITBUCKET_TEST_USERNAME is empty.")
-	}
-
-	if pass == "" {
-		t.Error("BITBUCKET_TEST_PASSWORD is empty.")
-	}
+	user := getUsername()
+	pass := getPassword()
 
 	c := bitbucket.NewBasicAuth(user, pass)
 
 	res, err := c.User.Profile()
-	if err != nil {
-		t.Error(err)
+
+	assert.NoError(t, err)
+	assert.NotNil(t, res)
+}
+
+func getUsername() string {
+	ev := os.Getenv("BITBUCKET_TEST_USERNAME")
+	if ev != "" {
+		return ev
 	}
 
-	if res.Username != user {
-		t.Error("Cannot catch the Profile.username.")
+	return "example-username"
+}
+
+func getPassword() string {
+	ev := os.Getenv("BITBUCKET_TEST_PASSWORD")
+	if ev != "" {
+		return ev
 	}
+
+	return "password"
 }

user.go

@@ -21,7 +21,7 @@ type User struct {
 
 // Profile is getting the user data
 func (u *User) Profile() (*User, error) {
-	urlStr := u.c.GetApiBaseURL() + "/user/"
+	urlStr := u.c.GetApiBaseURL() + "/user"
 	response, err := u.c.execute("GET", urlStr, "")
 	if err != nil {
 		return nil, err