TO and TP -- initial implementation of deliveryservice_requests endpoints

README.md

@@ -17,19 +17,19 @@
     under the License.
 -->
 
-Build: [![Build Status](https://builds.apache.org/buildStatus/icon?job=incubator-trafficcontrol-master-build)](https://builds.apache.org/view/Incubator%20Projects/job/incubator-trafficcontrol-master-build/)
+[![Build Status](https://builds.apache.org/buildStatus/icon?job=incubator-trafficcontrol-master-build)](https://builds.apache.org/view/Incubator%20Projects/job/incubator-trafficcontrol-master-build/) [![Documentation Status](https://readthedocs.org/projects/traffic-control-cdn/badge/?version=latest)](http://traffic-control-cdn.readthedocs.io/en/latest/?badge=latest)
 
 Apache Traffic Control (incubating) is an Open Source implementation of a Content Delivery Network.
 
 #### Documentation
-* [Intro](http://trafficcontrol.apache.org/docs/latest/index.html)
-* [CDN Basics](http://trafficcontrol.apache.org/docs/latest/basics/index.html)
-* [Traffic Control Overview](http://trafficcontrol.apache.org/docs/latest/overview/index.html)
-* [Administrator's Guide](http://trafficcontrol.apache.org/docs/latest/admin/index.html)
-* [Developer's Guide](http://trafficcontrol.apache.org/docs/latest/development/index.html)
+* [Intro](http://traffic-control-cdn.readthedocs.io/en/latest/index.html)
+* [CDN Basics](http://traffic-control-cdn.readthedocs.io/en/latest/basics/index.html)
+* [Traffic Control Overview](http://traffic-control-cdn.readthedocs.io/en/latest/overview/index.html)
+* [Administrator's Guide](http://traffic-control-cdn.readthedocs.io/en/latest/admin/index.html)
+* [Developer's Guide](http://traffic-control-cdn.readthedocs.io/en/latest/development/index.html)
 
-####Questions, Comments, Bugs and More
-* [Frequently Asked Questions](http://trafficcontrol.apache.org/docs/latest/faq/index.html)
+####  Questions, Comments, Bugs and More
+* [Frequently Asked Questions](http://traffic-control-cdn.readthedocs.io/en/latest/faq/index.html)
 * [Found a bug or file a feature request](https://github.com/apache/incubator-trafficcontrol/issues)
 * [Subscribe to our users list](mailto:users-subscribe@trafficcontrol.incubator.apache.org)
 * [Subscribe to our dev list](mailto:dev-subscribe@trafficcontrol.incubator.apache.org)

lib/go-tc/alerts_test.go

@@ -35,17 +35,17 @@ func TestGetHandleErrorFunc(t *testing.T) {
 	}
 	body := `{"alerts":[{"text":"this is an error","level":"error"}]}`
 
-	errHandler := GetHandleErrorFunc(w, r)
-	errHandler(fmt.Errorf("this is an error"), http.StatusBadRequest)
+	errHandler := GetHandleErrorsFunc(w, r)
+	errHandler(http.StatusBadRequest, fmt.Errorf("this is an error"))
 	if w.Body.String() != body {
 		t.Error("Expected body", body, "got", w.Body.String())
 	}
 
 	w = httptest.NewRecorder()
 	body = `{"alerts":[]}`
 
-	errHandler = GetHandleErrorFunc(w, r)
-	errHandler(nil, http.StatusBadRequest)
+	errHandler = GetHandleErrorsFunc(w, r)
+	errHandler(http.StatusBadRequest, nil)
 	if w.Body.String() != body {
 		t.Error("Expected body", body, "got", w.Body.String())
 	}

lib/go-tc/deliveryservice_requests.go

@@ -0,0 +1,55 @@
+package tc
+
+/*
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+import (
+	"encoding/json"
+)
+
+// DeliveryServiceRequestNullable is used as part of the workflow to create,
+// modify, or delete a delivery service.
+type DeliveryServiceRequest struct {
+	AssigneeID      int             `json:"assigneeId,omitempty" db:"assignee_id"`
+	Assignee        string          `json:"assignee,omitempty"`
+	AuthorID        int             `json:"authorId" db:"author_id"`
+	Author          string          `json:"author"`
+	ChangeType      string          `json:"changeType" db:"change_type"`
+	CreatedAt       string          `json:"createdAt,omitempty" db:"created_at"`
+	ID              int             `json:"id" db:"id"`
+	LastEditedBy    string          `json:"lastEditedBy"`
+	LastEditedByID  int             `json:"lastEditedById" db:"last_edited_by_id"`
+	LastUpdated     string          `json:"lastUpdated,omitempty" db:"last_updated"`
+	Deliveryservice json.RawMessage `json:"deliveryservice" db:"deliveryservice"`
+	Status          string          `json:"status" db:"status"`
+}
+
+// DeliveryServiceRequestNullable is used as part of the workflow to create,
+// modify, or delete a delivery service.
+type DeliveryServiceRequestNullable struct {
+	AssigneeID      *int            `json:"assigneeId,omitempty" db:"assignee_id"`
+	Assignee        *string         `json:"assignee,omitempty"`
+	AuthorID        int             `json:"authorId" db:"author_id"`
+	Author          string          `json:"author"`
+	ChangeType      string          `json:"changeType" db:"change_type"`
+	CreatedAt       Time            `json:"createdAt" db:"created_at"`
+	ID              int             `json:"id" db:"id"`
+	LastEditedBy    string          `json:"lastEditedBy"`
+	LastEditedByID  int             `json:"lastEditedById" db:"last_edited_by_id"`
+	LastUpdated     Time            `json:"lastUpdated" db:"last_updated"`
+	Deliveryservice json.RawMessage `json:"deliveryservice" db:"deliveryservice"`
+	Status          string          `json:"status" db:"status"`
+	XMLID           string          `json:"-" db:"xml_id"`
+}

lib/go-tc/deliveryservices.go

@@ -90,7 +90,7 @@ type DeliveryService struct {
 	RangeRequestHandling int                    `json:"rangeRequestHandling"`
 	EdgeHeaderRewrite    string                 `json:"edgeHeaderRewrite"`
 	MidHeaderRewrite     string                 `json:"midHeaderRewrite"`
-	TenantID             int                    `json:"tenant_id,omitempty"`
+	TenantID             int                    `json:"tenantId,omitempty"`
 	TRResponseHeaders    string                 `json:"trResponseHeaders"`
 	RegexRemap           string                 `json:"regexRemap"`
 	CacheURL             string                 `json:"cacheurl"`

lib/go-tc/time.go

@@ -21,7 +21,6 @@ package tc
 
 import (
 	"database/sql/driver"
-	"fmt"
 	"strings"
 	"time"
 )
@@ -32,7 +31,7 @@ type Time struct {
 }
 
 // TimeLayout is the format used in lastUpdated fields in Traffic Ops
-const TimeLayout = "2006-01-02 15:04:05+00"
+const TimeLayout = "2006-01-02 15:04:05-07"
 
 // Scan implements the database/sql Scanner interface.
 func (jt *Time) Scan(value interface{}) error {
@@ -53,7 +52,7 @@ func (t *Time) MarshalJSON() ([]byte, error) {
 	if t.Time.IsZero() {
 		return []byte("null"), nil
 	}
-	return []byte(fmt.Sprintf("\"%s\"", t.Time.Format(TimeLayout))), nil
+	return []byte(`"` + t.Time.Format(TimeLayout) + `"`), nil
 }
 
 // UnmarshalJSON reads time from JSON into Time var

traffic_ops/app/db/migrations/20171226000000_add-ds-request.sql

@@ -0,0 +1,50 @@
+/*
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+*/
+
+-- +goose Up
+-- SQL in section 'Up' is executed when this migration is applied
+CREATE TYPE workflow_states AS ENUM ('draft', 'submitted', 'rejected', 'pending', 'complete');
+CREATE TYPE change_types AS ENUM ('create', 'update', 'delete');
+
+CREATE TABLE deliveryservice_request (
+    assignee_id bigint,
+    author_id bigint NOT NULL,
+    change_type change_types NOT NULL,
+    created_at timestamp WITH time zone NOT NULL DEFAULT now(),
+    id bigserial primary key NOT NULL,
+    last_edited_by_id bigint NOT NULL,
+    last_updated timestamp WITH time zone NOT NULL DEFAULT now(),
+    deliveryservice jsonb NOT NULL,
+    status workflow_states NOT NULL
+);
+
+ALTER TABLE deliveryservice_request
+    ADD CONSTRAINT fk_author FOREIGN KEY (author_id) REFERENCES tm_user(id) ON DELETE CASCADE;
+
+ALTER TABLE deliveryservice_request
+    ADD CONSTRAINT fk_assignee FOREIGN KEY (assignee_id) REFERENCES tm_user(id) ON DELETE SET NULL;
+
+ALTER TABLE deliveryservice_request
+    ADD CONSTRAINT fk_last_edited_by FOREIGN KEY (last_edited_by_id) REFERENCES tm_user(id) ON DELETE CASCADE;
+
+CREATE TRIGGER on_update_current_timestamp BEFORE UPDATE ON deliveryservice_request FOR EACH ROW EXECUTE PROCEDURE on_update_current_timestamp_last_updated();
+
+-- +goose Down
+-- SQL section 'Down' is executed when this migration is rolled back
+DROP TABLE deliveryservice_request;
+
+DROP TYPE change_types;
+
+DROP TYPE workflow_states;

traffic_ops/app/lib/API/Configs/ApacheTrafficServer.pm

@@ -2198,6 +2198,7 @@ sub cachegroup_profiles {
 				port           => $self->profile_param_value( $pid, 'parent.config', 'port', undef ),
 				use_ip_address => $self->profile_param_value( $pid, 'parent.config', 'use_ip_address', 0 ),
 				rank           => $self->profile_param_value( $pid, 'parent.config', 'rank', 1 ),
+				not_a_parent   => $self->profile_param_value( $pid, 'parent.config', 'not_a_parent', 'false' ),
 			};
 		}
 	}
@@ -2235,6 +2236,9 @@ sub parent_data {
 	foreach my $prefix ( keys %deliveryservices ) {
 		foreach my $row ( @{ $deliveryservices{$prefix} } ) {
 			my $pid              = $row->profile->id;
+			if ( $profile_cache{$pid}->{not_a_parent} ne 'false' ) {
+				next;
+			}
 			my $ds_domain        = $profile_cache{$pid}->{domain_name};
 			my $weight           = $profile_cache{$pid}->{weight};
 			my $port             = $profile_cache{$pid}->{port};

traffic_ops/client/deliveryservice_requests.go

@@ -0,0 +1,135 @@
+/*
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package client
+
+import (
+	"encoding/json"
+	"net"
+	"net/http"
+
+	"github.com/apache/incubator-trafficcontrol/lib/go-log"
+	"github.com/apache/incubator-trafficcontrol/lib/go-tc"
+)
+
+const (
+	API_DS_REQUESTS = "/api/1.3/deliveryservice_requests"
+)
+
+// Create a Delivery Service Request
+func (to *Session) CreateDeliveryServiceRequest(dsr tc.DeliveryServiceRequest) (tc.Alerts, ReqInf, error) {
+
+	var remoteAddr net.Addr
+	reqBody, err := json.Marshal(dsr)
+	log.Debugln("Request: ", string(reqBody))
+	reqInf := ReqInf{CacheHitStatus: CacheHitStatusMiss, RemoteAddr: remoteAddr}
+	if err != nil {
+		return tc.Alerts{}, reqInf, err
+	}
+	resp, remoteAddr, err := to.request(http.MethodPost, API_DS_REQUESTS, reqBody)
+	if err != nil {
+		return tc.Alerts{}, reqInf, err
+	}
+	defer resp.Body.Close()
+	var alerts tc.Alerts
+	err = json.NewDecoder(resp.Body).Decode(&alerts)
+	return alerts, reqInf, nil
+}
+
+/*
+// Update a DeliveryServiceRequest by ID
+func (to *Session) UpdateDeliveryServiceRequestByID(id int, dsr tc.DeliveryServiceRequest) (tc.Alerts, ReqInf, error) {
+
+	var remoteAddr net.Addr
+	reqBody, err := json.Marshal(dsr)
+	reqInf := ReqInf{CacheHitStatus: CacheHitStatusMiss, RemoteAddr: remoteAddr}
+	if err != nil {
+		return tc.Alerts{}, reqInf, err
+	}
+	route := fmt.Sprintf("%s/%d", API_DS_REQUESTS, id)
+	resp, remoteAddr, err := to.request(http.MethodPut, route, reqBody)
+	if err != nil {
+		return tc.Alerts{}, reqInf, err
+	}
+	defer resp.Body.Close()
+	var alerts tc.Alerts
+	err = json.NewDecoder(resp.Body).Decode(&alerts)
+	return alerts, reqInf, nil
+}
+
+// Returns a list of DeliveryServiceRequests
+func (to *Session) GetDeliveryServiceRequests() ([]tc.DeliveryServiceRequest, ReqInf, error) {
+	resp, remoteAddr, err := to.request(http.MethodGet, API_DS_REQUESTS, nil)
+	reqInf := ReqInf{CacheHitStatus: CacheHitStatusMiss, RemoteAddr: remoteAddr}
+	if err != nil {
+		return nil, reqInf, err
+	}
+	defer resp.Body.Close()
+
+	var data tc.DeliveryServiceRequestsResponse
+	err = json.NewDecoder(resp.Body).Decode(&data)
+	return data.Response, reqInf, nil
+}
+
+// GET a DeliveryServiceRequest by the DeliveryServiceRequest id
+func (to *Session) GetDeliveryServiceRequestByID(id int) ([]tc.DeliveryServiceRequest, ReqInf, error) {
+	route := fmt.Sprintf("%s/%d", API_DS_REQUESTS, id)
+	resp, remoteAddr, err := to.request(http.MethodGet, route, nil)
+	reqInf := ReqInf{CacheHitStatus: CacheHitStatusMiss, RemoteAddr: remoteAddr}
+	if err != nil {
+		return nil, reqInf, err
+	}
+	defer resp.Body.Close()
+
+	var data tc.DeliveryServiceRequestsResponse
+	if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
+		return nil, reqInf, err
+	}
+
+	return data.Response, reqInf, nil
+}
+
+// GET a DeliveryServiceRequest by the DeliveryServiceRequest assignee
+func (to *Session) GetDeliveryServiceRequestByAssignee(assignee string) ([]tc.DeliveryServiceRequest, ReqInf, error) {
+	url := fmt.Sprintf("%s/assignee/%s", API_DS_REQUESTS, assignee)
+	resp, remoteAddr, err := to.request(http.MethodGet, url, nil)
+	reqInf := ReqInf{CacheHitStatus: CacheHitStatusMiss, RemoteAddr: remoteAddr}
+	if err != nil {
+		return nil, reqInf, err
+	}
+	defer resp.Body.Close()
+
+	var data tc.DeliveryServiceRequestsResponse
+	if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
+		return nil, reqInf, err
+	}
+
+	return data.Response, reqInf, nil
+}
+
+// DELETE a DeliveryServiceRequest by DeliveryServiceRequest assignee
+func (to *Session) DeleteDeliveryServiceRequestByAssignee(assignee string) (tc.Alerts, ReqInf, error) {
+	route := fmt.Sprintf("%s/assignee/%s", API_DS_REQUESTS, assignee)
+	resp, remoteAddr, err := to.request(http.MethodDelete, route, nil)
+	reqInf := ReqInf{CacheHitStatus: CacheHitStatusMiss, RemoteAddr: remoteAddr}
+	if err != nil {
+		return tc.Alerts{}, reqInf, err
+	}
+	defer resp.Body.Close()
+	var alerts tc.Alerts
+	err = json.NewDecoder(resp.Body).Decode(&alerts)
+	return alerts, reqInf, nil
+}
+*/

traffic_ops/testing/api/config.go → traffic_ops/testing/api/config/config.go

@@ -14,14 +14,15 @@
    limitations under the License.
 */
 
-package api
+package config
 
 import (
 	"encoding/json"
 	"fmt"
 	"io/ioutil"
 	"os"
 
+	log "github.com/apache/incubator-trafficcontrol/lib/go-log"
 	"github.com/kelseyhightower/envconfig"
 )
 
@@ -118,3 +119,28 @@ func LoadConfig(confPath string) (Config, error) {
 
 	return cfg, err
 }
+
+// ErrorLog - critical messages
+func (c Config) ErrorLog() log.LogLocation {
+	return log.LogLocation(c.Default.Log.Error)
+}
+
+// WarningLog - warning messages
+func (c Config) WarningLog() log.LogLocation {
+	return log.LogLocation(c.Default.Log.Warning)
+}
+
+// InfoLog - information messages
+func (c Config) InfoLog() log.LogLocation {
+	return log.LogLocation(c.Default.Log.Info)
+}
+
+// DebugLog - troubleshooting messages
+func (c Config) DebugLog() log.LogLocation {
+	return log.LogLocation(c.Default.Log.Debug)
+}
+
+// EventLog - access.log high level transactions
+func (c Config) EventLog() log.LogLocation {
+	return log.LogLocation(c.Default.Log.Event)
+}