This is an automated email from the ASF dual-hosted git repository.
ocket8888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 2352569863 Update unversioned references to Traffic Ops client library
to API v4 (#6917)
2352569863 is described below
commit 235256986342c411c515554d871a2269b0169d5d
Author: Zach Hoffman <[email protected]>
AuthorDate: Tue Jul 12 08:51:40 2022 -0600
Update unversioned references to Traffic Ops client library to API v4
(#6917)
* Update unversioned references to Traffic Ops client library to API v4
* Version more unversioned references to Traffic Ops client
---
cache-config/t3c-generate/update-to-client/update-to-client.go | 4 ++--
docs/source/development/traffic_ops.rst | 2 +-
docs/source/development/traffic_stats.rst | 4 ++--
lib/go-atscfg/atscfg.go | 2 +-
4 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/cache-config/t3c-generate/update-to-client/update-to-client.go
b/cache-config/t3c-generate/update-to-client/update-to-client.go
index 91098e693f..d2d5e98ac9 100644
--- a/cache-config/t3c-generate/update-to-client/update-to-client.go
+++ b/cache-config/t3c-generate/update-to-client/update-to-client.go
@@ -72,7 +72,7 @@ Also be aware! This is very specific to the current code. If
symbols or patterns
Expecations:
- t3c-generate is at github.com/apache/trafficcontrol/cache-config/t3c-generate
-- The master TO client is at
github.com/apache/trafficcontrol/traffic_ops/client
+- The master TO client is at
github.com/apache/trafficcontrol/traffic_ops/v4-client
- The previous major version client is vendored at t3c-generate/toreq/vendor
- The master client wrapper for t3c-generate is at t3c-generate/toreqnew
- The clients are stored in config.TCCfg.TOClient and config.TCCfg.TOClientNew
@@ -86,7 +86,7 @@ The arguments are the t3c-generate directory, and the name of
the branch to vend
This script should always be called from
trafficcontrol/cache-config/t3c-generate.
-It copies the traffic_ops/client from that branch into toreq/vendor,
+It copies the traffic_ops/v4-client from that branch into toreq/vendor,
and then updates all references to cfg.TOClientNew to cfg.TOClient.
This must be done as soon as a release is made, before any new features are
added to t3c-generate.
diff --git a/docs/source/development/traffic_ops.rst
b/docs/source/development/traffic_ops.rst
index 00ff9c180e..859e542e16 100644
--- a/docs/source/development/traffic_ops.rst
+++ b/docs/source/development/traffic_ops.rst
@@ -147,7 +147,7 @@ Traffic Ops Project Tree Overview
- ort/ - Contains :term:`ORT` and :abbr:`ATS (Apache Traffic Server)`
configuration file-generation logic and tooling
- testing/ - Holds utilities for testing the :ref:`to-api`
- - api/ - Integration testing for the `Traffic Ops Go client
<https://pkg.go.dev/github.com/apache/trafficcontrol/traffic_ops/client>`_ and
Traffic Ops
+ - api/ - Integration testing for the `Traffic Ops Go client
<https://pkg.go.dev/github.com/apache/trafficcontrol/traffic_ops/v4-client>`_
and Traffic Ops
- traffic_ops_golang/ - The root of the Go implementation's code-base
diff --git a/docs/source/development/traffic_stats.rst
b/docs/source/development/traffic_stats.rst
index 222f603e90..3637ec7d53 100644
--- a/docs/source/development/traffic_stats.rst
+++ b/docs/source/development/traffic_stats.rst
@@ -46,8 +46,8 @@ In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the
standard for formatt
Installing The Developer Environment
====================================
#. Clone the traffic_control repository using Git into a location accessible
by your $GOPATH
-#. Navigate to the traffic_ops/client directory of your cloned repository.
(This is the directory containing Traffic Ops client code used by Traffic Stats)
-#. From the traffic_ops/client directory run ``go test`` to test the client
code. This will run all unit tests for the client and return the results. If
there are missing dependencies you will need to run ``go mod vendor -v`` to get
the dependencies
+#. Navigate to the :atc-file:`traffic_ops/v4-client` directory of your cloned
repository. (This is the directory containing Traffic Ops client code used by
Traffic Stats)
+#. From the :atc-file:`traffic_ops/v4-client` directory, run ``go test`` to
test the client code. This will run all unit tests for the client and return
the results. If there are missing dependencies you will need to run ``go mod
vendor -v`` to get the dependencies
#. Once the tests pass, run ``go install`` to build and install the Traffic
Ops client package. This makes it accessible to Traffic Stats.
#. Navigate to your cloned repository under Traffic Stats
#. Run ``go build traffic_stats.go`` to build traffic_stats. You will need to
run ``go mod vendor -v`` for any missing dependencies.
diff --git a/lib/go-atscfg/atscfg.go b/lib/go-atscfg/atscfg.go
index ce87f35fab..d25049d520 100644
--- a/lib/go-atscfg/atscfg.go
+++ b/lib/go-atscfg/atscfg.go
@@ -80,7 +80,7 @@ func ToDeliveryServices(dses []tc.DeliveryServiceV40)
[]DeliveryService {
return ad
}
-// V40ToDeliveryServices converts a slice of the old traffic_ops/client type
to the local alias.
+// V40ToDeliveryServices converts a slice of the old traffic_ops/v4-client
type to the local alias.
func V40ToDeliveryServices(dses []tc.DeliveryServiceV40) []DeliveryService {
ad := make([]DeliveryService, 0, len(dses))
for _, ds := range dses {
