Add required capabilities to delivery service structure (#7224)

* initial commit

* fix unit test

* code review

* code review round 2

* fix unit test

* add allocation

* code review

* code review

* remove superfluous call to WriteHeader

* go fmt

CHANGELOG.md

@@ -24,6 +24,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - [#7113](https://github.com/apache/trafficcontrol/pull/7113) *Traffic Portal* Minimize the Server Server Capability part of the *Traffic Servers* section of the Snapshot Diff
 
 ### Changed
+- [#7224](https://github.com/apache/trafficcontrol/pull/7224) *Traffic Ops* Required Capabilities are now a part of the `DeliveryService` structure.
 - [#7063](https://github.com/apache/trafficcontrol/pull/7063) *Traffic Ops* Python client now uses Traffic Ops API 4.1 by default.
 - [#6981](https://github.com/apache/trafficcontrol/pull/6981) *Traffic Portal* Obscures sensitive text in Delivery Service "Raw Remap" fields, private SSL keys, "Header Rewrite" rules, and ILO interface passwords by default.
 - [#7037](https://github.com/apache/trafficcontrol/pull/7037) *Traffic Router* Uses Traffic Ops API 4.0 by default

cache-config/testing/ort-tests/tcdata/todb.go

@@ -247,7 +247,6 @@ func (r *TCData) Teardown(db *sql.DB) error {
 
 	sqlStmt := `
 	DELETE FROM api_capability;
-	DELETE FROM deliveryservices_required_capability;
 	DELETE FROM server_server_capability;
 	DELETE FROM server_capability;
 	DELETE FROM to_extension;

docs/source/api/v4/deliveryservice_requests.rst

@@ -72,7 +72,7 @@ Request Structure
 .. code-block:: http
 	:caption: Request Example
 
-	GET /api/4.0/deliveryservice_requests?status=draft HTTP/1.1
+	GET /api/4.1/deliveryservice_requests?status=draft HTTP/1.1
 	User-Agent: python-requests/2.22.0
 	Accept-Encoding: gzip, deflate
 	Accept: */*
@@ -163,6 +163,7 @@ The response is an array of representations of :term:`Delivery Service Requests`
 			"regional": false,
 			"regionalGeoBlocking": false,
 			"remapText": null,
+			"requiredCapabilities": [],
 			"routingName": "video",
 			"signed": false,
 			"sslKeyVersion": 1,
@@ -213,7 +214,7 @@ The request must be a well-formed representation of a :term:`Delivery Service Re
 .. code-block:: http
 	:caption: Request Example
 
-	POST /api/4.0/deliveryservice_requests HTTP/1.1
+	POST /api/4.1/deliveryservice_requests HTTP/1.1
 	User-Agent: python-requests/2.22.0
 	Accept-Encoding: gzip, deflate
 	Accept: */*
@@ -280,6 +281,7 @@ The request must be a well-formed representation of a :term:`Delivery Service Re
 			"regional": false,
 			"regionalGeoBlocking": false,
 			"remapText": null,
+			"requiredCapabilities": [],
 			"routingName": "video",
 			"signed": false,
 			"sslKeyVersion": 1,
@@ -328,7 +330,7 @@ The response will be a representation of the created :term:`Delivery Service Req
 	Content-Encoding: gzip
 	Content-Type: application/json
 	Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 20:11:12 GMT; Max-Age=3600; HttpOnly
-	Location: /api/4.0/deliveryservice_requests/2
+	Location: /api/4.1/deliveryservice_requests/2
 	X-Server-Name: traffic_ops_golang/
 	Date: Mon, 24 Feb 2020 19:11:12 GMT
 	Content-Length: 901
@@ -405,6 +407,7 @@ The response will be a representation of the created :term:`Delivery Service Req
 				"regional": false,
 				"regionalGeoBlocking": false,
 				"remapText": null,
+				"requiredCapabilities": [],
 				"routingName": "video",
 				"signed": false,
 				"sslKeyVersion": 1,
@@ -490,6 +493,7 @@ The response will be a representation of the created :term:`Delivery Service Req
 				"regional": false,
 				"regionalGeoBlocking": false,
 				"remapText": null,
+				"requiredCapabilities": [],
 				"routingName": "video",
 				"signed": false,
 				"sslKeyVersion": 1,
@@ -550,7 +554,7 @@ The request body must be a representation of a :term:`Delivery Service Request`
 .. code-block:: http
 	:caption: Request Example
 
-	PUT /api/4.0/deliveryservice_requests?id=1 HTTP/1.1
+	PUT /api/4.1/deliveryservice_requests?id=1 HTTP/1.1
 	User-Agent: python-requests/2.22.0
 	Accept-Encoding: gzip, deflate
 	Accept: */*
@@ -667,6 +671,7 @@ The response is a full representation of the edited :term:`Delivery Service Requ
 			"regional": false,
 			"regionalGeoBlocking": false,
 			"remapText": null,
+			"requiredCapabilities": [],
 			"routingName": "video",
 			"signed": false,
 			"sslKeyVersion": 1,
@@ -748,6 +753,7 @@ The response is a full representation of the edited :term:`Delivery Service Requ
 			"regional": false,
 			"regionalGeoBlocking": false,
 			"remapText": null,
+			"requiredCapabilities": [],
 			"routingName": "cdn",
 			"signed": false,
 			"sslKeyVersion": null,
@@ -800,7 +806,7 @@ Request Structure
 .. code-block:: http
 	:caption: Request Example
 
-	DELETE /api/4.0/deliveryservice_requests?id=1 HTTP/1.1
+	DELETE /api/4.1/deliveryservice_requests?id=1 HTTP/1.1
 	User-Agent: python-requests/2.22.0
 	Accept-Encoding: gzip, deflate
 	Accept: */*

docs/source/api/v4/deliveryservice_requests_id_assign.rst

@@ -42,7 +42,7 @@ Request Structure
 .. code-block:: http
 	:caption: Request Example
 
-	GET /api/4.0/deliveryservice_requests/1/assign HTTP/1.1
+	GET /api/4.1/deliveryservice_requests/1/assign HTTP/1.1
 	User-Agent: python-requests/2.24.0
 	Accept-Encoding: gzip, deflate
 	Accept: */*
@@ -103,7 +103,7 @@ Request Structure
 .. code-block:: http
 	:caption: Request Example
 
-	PUT /api/4.0/deliveryservice_requests/1/assign HTTP/1.1
+	PUT /api/4.1/deliveryservice_requests/1/assign HTTP/1.1
 	User-Agent: python-requests/2.24.0
 	Accept-Encoding: gzip, deflate
 	Accept: */*
@@ -198,6 +198,7 @@ The response contains a full representation of the newly assigned :term:`Deliver
 			"regional": false,
 			"regionalGeoBlocking": false,
 			"remapText": null,
+			"requiredCapabilities": [],
 			"routingName": "video",
 			"signed": false,
 			"sslKeyVersion": 1,
@@ -279,6 +280,7 @@ The response contains a full representation of the newly assigned :term:`Deliver
 			"regional": false,
 			"regionalGeoBlocking": false,
 			"remapText": null,
+			"requiredCapabilities": [],
 			"routingName": "cdn",
 			"signed": false,
 			"sslKeyVersion": null,

docs/source/api/v4/deliveryservice_requests_id_status.rst

@@ -45,7 +45,7 @@ Request Structure
 .. code-block:: http
 	:caption: Request Example
 
-	GET /api/4.0/deliveryservice_requests/1/status HTTP/1.1
+	GET /api/4.1/deliveryservice_requests/1/status HTTP/1.1
 	User-Agent: python-requests/2.24.0
 	Accept-Encoding: gzip, deflate
 	Accept: */*
@@ -98,7 +98,7 @@ Request Structure
 .. code-block:: http
 	:caption: Request Example
 
-	PUT /api/4.0/deliveryservice_requests/1/status HTTP/1.1
+	PUT /api/4.1/deliveryservice_requests/1/status HTTP/1.1
 	User-Agent: python-requests/2.22.0
 	Accept-Encoding: gzip, deflate
 	Accept: */*
@@ -195,6 +195,7 @@ The response is a full representation of the modified :term:`DSR`.
 			"regional": false,
 			"regionalGeoBlocking": false,
 			"remapText": null,
+			"requiredCapabilities": [],
 			"routingName": "video",
 			"signed": false,
 			"sslKeyVersion": 1,
@@ -276,6 +277,7 @@ The response is a full representation of the modified :term:`DSR`.
 			"regional": false,
 			"regionalGeoBlocking": false,
 			"remapText": null,
+			"requiredCapabilities": [],
 			"routingName": "cdn",
 			"signed": false,
 			"sslKeyVersion": null,

docs/source/api/v4/deliveryservices.rst

@@ -73,7 +73,7 @@ Request Structure
 .. code-block:: http
 	:caption: Request Example
 
-	GET /api/4.0/deliveryservices?xmlId=demo2 HTTP/1.1
+	GET /api/4.1/deliveryservices?xmlId=demo2 HTTP/1.1
 	Host: trafficops.infra.ciab.test
 	User-Agent: python-requests/2.24.0
 	Accept-Encoding: gzip, deflate
@@ -148,6 +148,10 @@ Response Structure
 :regional:              A boolean value defining the :ref:`ds-regional` setting on this :term:`Delivery Service`
 :regionalGeoBlocking:   A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
 :remapText:             :ref:`ds-raw-remap`
+:requiredCapabilities:  An array of the capabilities that this Delivery Service requires.
+
+	.. versionadded:: 4.1
+
 :serviceCategory:       The name of the :ref:`ds-service-category` with which the :term:`Delivery Service` is associated
 :signed:                ``true`` if  and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
 :signingAlgorithm:      Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
@@ -250,6 +254,7 @@ Response Structure
 			"regional": false,
 			"regionalGeoBlocking": false,
 			"remapText": null,
+			"requiredCapabilities": [],
 			"routingName": "video",
 			"serviceCategory": null,
 			"signed": false,
@@ -328,6 +333,10 @@ Request Structure
 :regional:                  A boolean value defining the :ref:`ds-regional` setting on this :term:`Delivery Service`
 :regionalGeoBlocking:       A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
 :remapText:                 :ref:`ds-raw-remap`
+:requiredCapabilities:      An array of the capabilities that this Delivery Service requires.
+
+	.. versionadded:: 4.1
+
 :serviceCategory:           The name of the :ref:`ds-service-category` with which the :term:`Delivery Service` is associated - or ``null`` if there is to be no such category
 :signed:                    ``true`` if  and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
 :signingAlgorithm:          Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
@@ -348,7 +357,7 @@ Request Structure
 .. code-block:: http
 	:caption: Request Example
 
-	POST /api/4.0/deliveryservices HTTP/1.1
+	POST /api/4.1/deliveryservices HTTP/1.1
 	User-Agent: python-requests/2.24.0
 	Accept-Encoding: gzip, deflate
 	Accept: */*
@@ -407,6 +416,7 @@ Request Structure
 		"regexRemap": null,
 		"regional": false,
 		"regionalGeoBlocking": false,
+		"requiredCapabilities": [],
 		"routingName": "test",
 		"serviceCategory": null,
 		"signed": false,
@@ -495,6 +505,10 @@ Response Structure
 :regional:              A boolean value defining the :ref:`ds-regional` setting on this :term:`Delivery Service`
 :regionalGeoBlocking:   A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
 :remapText:             :ref:`ds-raw-remap`
+:requiredCapabilities:  An array of the capabilities that this Delivery Service requires.
+
+	.. versionadded:: 4.1
+
 :serviceCategory:       The name of the :ref:`ds-service-category` with which the :term:`Delivery Service` is associated
 :signed:                ``true`` if  and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
 :signingAlgorithm:      Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
@@ -522,7 +536,7 @@ Response Structure
 	Access-Control-Allow-Origin: *
 	Content-Encoding: gzip
 	Content-Type: application/json
-	Location: /api/4.0/deliveryservices?id=6
+	Location: /api/4.1/deliveryservices?id=6
 	Permissions-Policy: interest-cohort=()
 	Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 07 Jun 2021 23:37:37 GMT; Max-Age=3600; HttpOnly
 	Vary: Accept-Encoding
@@ -606,6 +620,7 @@ Response Structure
 		"regional": false,
 		"regionalGeoBlocking": false,
 		"remapText": null,
+		"requiredCapabilities": [],
 		"routingName": "test",
 		"serviceCategory": null,
 		"signed": false,

docs/source/api/v4/deliveryservices_id.rst

@@ -81,6 +81,10 @@ Request Structure
 :regional:                  A boolean value defining the :ref:`ds-regional` setting on this :term:`Delivery Service`
 :regionalGeoBlocking:       A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
 :remapText:                 :ref:`ds-raw-remap`
+:requiredCapabilities:      An array of the capabilities that this Delivery Service requires.
+
+	.. versionadded:: 4.1
+
 :routingName:               The :ref:`ds-routing-name` of this :term:`Delivery Service`
 
 		.. note:: If the Delivery Service has SSL Keys, then ``routingName`` is not allowed to change as that would invalidate the SSL Key
@@ -106,7 +110,7 @@ Request Structure
 .. code-block:: http
 	:caption: Request Example
 
-	PUT /api/4.0/deliveryservices/6 HTTP/1.1
+	PUT /api/4.1/deliveryservices/6 HTTP/1.1
 	Host: trafficops.infra.ciab.test
 	User-Agent: python-requests/2.24.0
 	Accept-Encoding: gzip, deflate
@@ -165,6 +169,7 @@ Request Structure
 		"regexRemap": null,
 		"regional": false,
 		"regionalGeoBlocking": false,
+		"requiredCapabilities": [],
 		"routingName": "test",
 		"serviceCategory": null,
 		"signed": false,
@@ -249,6 +254,10 @@ Response Structure
 :regexRemap:            A :ref:`ds-regex-remap`
 :regional:              A boolean value defining the :ref:`ds-regional` setting on this :term:`Delivery Service`
 :regionalGeoBlocking:   A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
+:requiredCapabilities:  An array of the capabilities that this Delivery Service requires.
+
+	.. versionadded:: 4.1
+
 :remapText:             :ref:`ds-raw-remap`
 :serviceCategory:       The name of the :ref:`ds-service-category` with which the :term:`Delivery Service` is associated
 :signed:                ``true`` if  and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
@@ -355,6 +364,7 @@ Response Structure
 		"regional": false,
 		"regionalGeoBlocking": false,
 		"remapText": null,
+		"requiredCapabilities": [],
 		"routingName": "test",
 		"serviceCategory": null,
 		"signed": false,
@@ -394,7 +404,7 @@ Request Structure
 .. code-block:: http
 	:caption: Request Example
 
-	DELETE /api/4.0/deliveryservices/2 HTTP/1.1
+	DELETE /api/4.1/deliveryservices/2 HTTP/1.1
 	Host: trafficops.infra.ciab.test
 	User-Agent: curl/7.47.0
 	Accept: */*

docs/source/api/v4/deliveryservices_required_capabilities.rst

@@ -19,6 +19,9 @@
 ``deliveryservices_required_capabilities``
 ******************************************
 
+.. deprecated:: 4.1
+	This endpoint will be removed in a future release, in favor of :ref:`ds-required-capabilities` being a part of :term:`Delivery Services`.
+
 ``GET``
 =======
 Gets all associations of :term:`Server Capability` to :term:`Delivery Services`.

docs/source/api/v4/servers_id_deliveryservices.rst

@@ -134,6 +134,10 @@ Response Structure
 :regional:             A boolean value defining the :ref:`ds-regional` setting on this :term:`Delivery Service`
 :regionalGeoBlocking:  A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
 :remapText:            :ref:`ds-raw-remap`
+:requiredCapabilities: An array of the capabilities that this Delivery Service requires.
+
+	.. versionadded:: 4.1
+
 :signed:               ``true`` if  and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
 :signingAlgorithm:     Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
 :rangeSliceBlockSize: An integer that defines the byte block size for the ATS Slice Plugin. It can only and must be set if ``rangeRequestHandling`` is set to 3.
@@ -234,6 +238,7 @@ Response Structure
 		"regional": false,
 		"regionalGeoBlocking": false,
 		"remapText": null,
+		"requiredCapabilities": [],
 		"routingName": "cdn",
 		"serviceCategory": null,
 		"signed": false,