Initial version of the TO API test tool via the Golang TO Client #1604

dewrich · 2017-11-29T21:52:29Z

The Traffic Ops API test tool implements a basic Traffic Ops API test suite that utilizes the Golang TO Client. This tool should help with the following issues:

The need for regression tests against the Traffic Ops API
Ensure that the Golang TO Client is being actively used, as well as grow it's
functionality to be in parity with the Traffic Ops API

High Level Features:

Setup from a clean database of the user to access the TO API
Teardown of all of the related traffic_ops database tables on startup to ensure test integrity
Utilizes the authorization.go module created in traffic_ops/traffic_ops_golang, which can also be used for the next Golang implementations for the TO Golang rewrite effort endponts /login and /users
All configuration (config file) options are overridable via command line environment variables, which sets the stage for Dockerization
Basic /cdns CRUD implemented (as well as enhancements to the TO Client to support the CRUD operations)
NO id centric test fixtures to be found in ./test_cdn.json to simplify maintenance. To load this file, the existing lib/go-tc Golang structs were used to allow for more reuse of the go-tc structs and continual use to ensure their accuracy.

TODOs:

Update README.md
Make the test_cdn.json a command line flag to allow for multiple test data sets
and default accordingly

asfgit · 2017-11-29T22:08:02Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/704/
Test PASSed.

dneuman64 · 2017-11-30T15:57:01Z

There is no description provided, so I have to ask, does this replace the golang client integration tests? https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_ops/client_tests/tests/integration

dewrich · 2017-11-30T17:08:03Z

@dneuman64 Yes, I wanted to separate the TO API client tests from the TO Client itself, so that the TO Client gets exercised as true external clients would. This helps catch any potential functions that need to be exported for TO Golang clients. I do plan on removing the old integration ones once this matures.

rob05c · 2017-11-30T18:13:57Z

traffic_ops/testing/api/test/wrapper.go

+	"fmt"
+	"net/http"
+
+	tc "github.com/apache/incubator-trafficcontrol/lib/go-tc"


This isn't hurting anything, but it doesn't strictly need the alias, Go will automatically import go-tc as tc.

asfgit · 2017-11-30T18:23:06Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/708/
Test PASSed.

asfgit · 2017-11-30T19:43:51Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/709/
Test PASSed.

dangogh

looks like the vendor directory could use some cleanup, too.. For instance, I don't see the /crypto library used at all...

dangogh · 2017-11-30T19:54:53Z

traffic_ops/client/cdn.go

-	return cdns, err
+var (
+	API_v2_CDNs = "/api/1.2/cdns"
+)


that should probably be a const

right, I'll fix

dangogh · 2017-11-30T19:57:16Z

traffic_ops/client/cdn.go

+	if err := json.NewDecoder(resp.Body).Decode(&alerts); err != nil {
+		return tc.Alerts{}, reqInf, err
+	}
+	return alerts, reqInf, nil


Don't need to check for err != nil, just return alerts, reqInf, err.

dangogh · 2017-11-30T19:58:54Z

traffic_ops/client/cdn.go

+	if err := json.NewDecoder(resp.Body).Decode(&alerts); err != nil {
+		return tc.Alerts{}, reqInf, err
+	}
+	return alerts, reqInf, nil


dangogh · 2017-11-30T20:01:21Z

traffic_ops/testing/api/TODO.md

@@ -0,0 +1 @@
+- Read the fixture .json file for TestCDNs


still needs the Apache license text...

dangogh · 2017-11-30T20:02:33Z

traffic_ops/testing/api/cdn_test.go

+import (
+	"testing"
+
+	log "github.com/apache/incubator-trafficcontrol/lib/go-log"


same comment as @rob05c had elsewhere -- import name is already log, so doesn't need to be specified here

dangogh · 2017-11-30T20:58:51Z

traffic_ops/testing/api/config.go

+
+	"github.com/kelseyhightower/envconfig"
+)
+


can this be reused from traffic_ops_golang?

If you are referring to using "vendor" code from other components, I have not been able to figure that out yet. But that dependency is only in this tool atm

It can, by putting traffic_ops_golang/config.go in its own package. So, move to traffic_ops_golang/config/config.go, and things like this can import (toconfig "traffic_ops_golang/config")

(I'd name the package toconfig directly if anything besides testing frameworks need it, but that seems unlikely.)

we should address this later...

dangogh · 2017-11-30T21:03:08Z

traffic_ops/testing/api/vendor/github.com/kelseyhightower/envconfig/.travis.yml

@@ -0,0 +1,10 @@
+language: go


this dir needs to be added to .rat-excludes at the top level of tc or rat will complain...

asfgit · 2017-11-30T21:18:21Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/710/
Test PASSed.

asfgit · 2017-11-30T21:28:05Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/711/
Test PASSed.

asfgit · 2017-11-30T21:43:02Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/712/
Test PASSed.

asfgit · 2017-12-04T16:00:57Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/715/
Test PASSed.

asfgit · 2017-12-04T17:44:26Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/719/
Test PASSed.

asfgit · 2017-12-04T20:19:06Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/724/
Test PASSed.

asfgit · 2017-12-04T20:28:05Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/725/
Test PASSed.

…ssword()

asfgit · 2017-12-04T21:43:08Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/726/
Test PASSed.

asfgit · 2017-12-06T21:55:26Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/737/
Test PASSed.

asfgit · 2017-12-07T17:23:04Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/742/
Test PASSed.

asfgit · 2017-12-07T20:21:42Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/744/
Test FAILed.

asfgit · 2017-12-07T21:54:53Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/748/
Test PASSed.

asfgit · 2017-12-07T22:23:09Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/749/
Test PASSed.

asfgit · 2017-12-07T23:30:06Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/750/
Test PASSed.

asfgit · 2017-12-07T23:32:39Z

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/incubator-trafficcontrol-PR/751/
Test PASSed.

dewrich added Traffic Ops API (golang) WIP "Work-in-Progress" - do not merge! (use 'draft' pull requests from now on) labels Nov 29, 2017

dewrich requested a review from dangogh November 30, 2017 15:32

dewrich added this to In Progress in TO API Golang Rewrite Nov 30, 2017

rob05c reviewed Nov 30, 2017

View reviewed changes

dewrich force-pushed the client-api-tests branch from e7f8840 to fcb92b2 Compare November 30, 2017 19:27

dangogh reviewed Nov 30, 2017

View reviewed changes

dewrich force-pushed the client-api-tests branch from 30cc89e to cb51e8a Compare December 4, 2017 15:49

dewrich added 8 commits December 4, 2017 14:15

initial version

95f1f09

updated todo

c934248

updated for configuring the password

479c088

success with logging into TO using the client and custom configuration

ab677d9

renamed sample_cdn.json to test_cdn.json and pointed to auth.DerivePa…

875953f

…ssword()

cleaned up dead code

9eddb15

cleaned up unused func

2242b6c

realigned the session variable to be reusable by the test cases

b8bc659

dewrich added 4 commits December 4, 2017 14:15

removed unused fixtures

fd17fe3

added better command line options for the fixtures and refactored

a00a6f6

added more startup info

5b0f812

made the TO Session timeout configurable

f94875e

dewrich force-pushed the client-api-tests branch from 9c43815 to f94875e Compare December 4, 2017 21:36

dewrich added this to the 2.2.0 milestone Dec 5, 2017

dewrich moved this from In Progress to In Review in TO API Golang Rewrite Dec 5, 2017

dewrich removed the WIP "Work-in-Progress" - do not merge! (use 'draft' pull requests from now on) label Dec 6, 2017

removed tc alias

cc62f0b

more PR review changes

25c56a8

fixed typos in README.md

ae03c68

dewrich added 3 commits December 7, 2017 14:43

updated README.md to point out password matching

cf0081e

updated the conf fields to make them more consistent

827a2e5

renamed the test fields so they do not run automatically

51f2d54

cleaned up go vet errs

edc58e0

dangogh added 3 commits December 7, 2017 16:14

go lint changes

f35d4b6

go lint changes

b37b1f4

go lint changes

957d4fd

dangogh merged commit 098cea1 into apache:master Dec 7, 2017

mitchell852 assigned dangogh Dec 8, 2017

mitchell852 added the change log label Dec 14, 2017

dewrich moved this from In Review to Done in TO API Golang Rewrite Feb 6, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial version of the TO API test tool via the Golang TO Client #1604

Initial version of the TO API test tool via the Golang TO Client #1604

dewrich commented Nov 29, 2017 •

edited

asfgit commented Nov 29, 2017

dneuman64 commented Nov 30, 2017

dewrich commented Nov 30, 2017

rob05c Nov 30, 2017

dewrich Nov 30, 2017

asfgit commented Nov 30, 2017

asfgit commented Nov 30, 2017

dangogh left a comment

dangogh Nov 30, 2017

dewrich Nov 30, 2017

dangogh Nov 30, 2017

dangogh Nov 30, 2017

dangogh Nov 30, 2017

dangogh Nov 30, 2017

dangogh Nov 30, 2017

dewrich Nov 30, 2017

rob05c Dec 6, 2017

dangogh Dec 7, 2017

dangogh Nov 30, 2017

asfgit commented Nov 30, 2017

asfgit commented Nov 30, 2017

asfgit commented Nov 30, 2017

asfgit commented Dec 4, 2017

asfgit commented Dec 4, 2017

asfgit commented Dec 4, 2017

asfgit commented Dec 4, 2017

asfgit commented Dec 4, 2017

asfgit commented Dec 6, 2017

asfgit commented Dec 7, 2017

asfgit commented Dec 7, 2017

asfgit commented Dec 7, 2017

asfgit commented Dec 7, 2017

asfgit commented Dec 7, 2017

asfgit commented Dec 7, 2017

Initial version of the TO API test tool via the Golang TO Client #1604

Initial version of the TO API test tool via the Golang TO Client #1604

Conversation

dewrich commented Nov 29, 2017 • edited

asfgit commented Nov 29, 2017

dneuman64 commented Nov 30, 2017

dewrich commented Nov 30, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asfgit commented Nov 30, 2017

asfgit commented Nov 30, 2017

dangogh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asfgit commented Nov 30, 2017

asfgit commented Nov 30, 2017

asfgit commented Nov 30, 2017

asfgit commented Dec 4, 2017

asfgit commented Dec 4, 2017

asfgit commented Dec 4, 2017

asfgit commented Dec 4, 2017

asfgit commented Dec 4, 2017

asfgit commented Dec 6, 2017

asfgit commented Dec 7, 2017

asfgit commented Dec 7, 2017

asfgit commented Dec 7, 2017

asfgit commented Dec 7, 2017

asfgit commented Dec 7, 2017

asfgit commented Dec 7, 2017

dewrich commented Nov 29, 2017 •

edited