From 74956aaf4d5d07d43af9a5c586a5868eee35e4a5 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Mon, 21 Nov 2022 18:10:00 -0700 Subject: [PATCH 01/21] Added description field to server capabilities --- CHANGELOG.md | 1 + lib/go-tc/server_capabilities.go | 1 + ...04800_add_description_in_sc_table.down.sql | 18 +++++ ...6304800_add_description_in_sc_table.up.sql | 18 +++++ .../api/v3/server_capabilities_test.go | 2 +- traffic_ops/testing/api/v3/tc-fixtures.json | 18 +++-- .../api/v4/server_capabilities_test.go | 12 +-- traffic_ops/testing/api/v4/tc-fixtures.json | 18 +++-- .../api/v5/server_capabilities_test.go | 12 +-- traffic_ops/testing/api/v5/tc-fixtures.json | 18 +++-- .../servercapability/servercapability.go | 21 ++++-- .../form.serverCapability.tpl.html | 8 ++ .../table.serverCapabilities.tpl.html | 2 + .../integration/Data/servercapabilities.ts | 73 ++++++++++++------- .../specs/ServerCapabilities.spec.ts | 8 +- 15 files changed, 159 insertions(+), 71 deletions(-) create mode 100644 traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.down.sql create mode 100644 traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.up.sql diff --git a/CHANGELOG.md b/CHANGELOG.md index 3dd5d1675d..64c4a14f49 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). ## [unreleased] ### Added +- [#6234](https://github.com/apache/trafficcontrol/issues/6234) *Traffic Ops, Traffic Portal* Added description field to Server Capabilities - [#6033](https://github.com/apache/trafficcontrol/issues/6033) *Traffic Ops, Traffic Portal* Added ability to assign multiple servers per capability. - [#7081](https://github.com/apache/trafficcontrol/issues/7081) *Traffic Router* Added better log messages for TR connection exceptions. - [#7089](https://github.com/apache/trafficcontrol/issues/7089) *Traffic Router* Added the ability to specify HTTPS certificate attributes. diff --git a/lib/go-tc/server_capabilities.go b/lib/go-tc/server_capabilities.go index 45ab68b2c2..7050902435 100644 --- a/lib/go-tc/server_capabilities.go +++ b/lib/go-tc/server_capabilities.go @@ -28,6 +28,7 @@ type ServerCapabilitiesResponse struct { // ServerCapability contains information about a given ServerCapability in Traffic Ops. type ServerCapability struct { Name string `json:"name" db:"name"` + Description string `json:"description" db:"description"` LastUpdated *TimeNoMod `json:"lastUpdated" db:"last_updated"` } diff --git a/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.down.sql b/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.down.sql new file mode 100644 index 0000000000..1974712758 --- /dev/null +++ b/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.down.sql @@ -0,0 +1,18 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with this + * work for additional information regarding copyright ownership. The ASF + * licenses this file to you 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. + */ + +ALTER TABLE public.server_capability DROP column description; diff --git a/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.up.sql b/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.up.sql new file mode 100644 index 0000000000..ef929918be --- /dev/null +++ b/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.up.sql @@ -0,0 +1,18 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with this + * work for additional information regarding copyright ownership. The ASF + * licenses this file to you 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. + */ + +ALTER TABLE public.server_capability ADD COLUMN IF NOT EXISTS description text DEFAULT NULL; diff --git a/traffic_ops/testing/api/v3/server_capabilities_test.go b/traffic_ops/testing/api/v3/server_capabilities_test.go index 961c665925..0be3a6d3da 100644 --- a/traffic_ops/testing/api/v3/server_capabilities_test.go +++ b/traffic_ops/testing/api/v3/server_capabilities_test.go @@ -46,7 +46,7 @@ func TestServerCapabilities(t *testing.T) { "POST": { "BAD REQUEST when INVALID NAME": { ClientSession: TOSession, - RequestBody: tc.ServerCapability{Name: "b@dname"}, + RequestBody: tc.ServerCapability{Name: "b@dname", Description: "Server Capability"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, }, diff --git a/traffic_ops/testing/api/v3/tc-fixtures.json b/traffic_ops/testing/api/v3/tc-fixtures.json index f392b2d5f1..66eaa1ef91 100644 --- a/traffic_ops/testing/api/v3/tc-fixtures.json +++ b/traffic_ops/testing/api/v3/tc-fixtures.json @@ -4822,22 +4822,28 @@ ], "serverCapabilities": [ { - "name": "foo" + "name": "foo", + "description": "server capability foo" }, { - "name": "bar" + "name": "bar", + "description": "server capability bar" }, { - "name": "ram" + "name": "ram", + "description": "server capability ram" }, { - "name": "disk" + "name": "disk", + "description": "server capability disk" }, { - "name": "asdf" + "name": "asdf", + "description": "server capability asdf" }, { - "name": "blah" + "name": "blah", + "description": "server capability blah" } ], "serverServerCapabilities": [ diff --git a/traffic_ops/testing/api/v4/server_capabilities_test.go b/traffic_ops/testing/api/v4/server_capabilities_test.go index c34e926387..118954e4fb 100644 --- a/traffic_ops/testing/api/v4/server_capabilities_test.go +++ b/traffic_ops/testing/api/v4/server_capabilities_test.go @@ -57,12 +57,12 @@ func TestServerCapabilities(t *testing.T) { "POST": { "BAD REQUEST when ALREADY EXISTS": { ClientSession: TOSession, - RequestBody: tc.ServerCapability{Name: "foo"}, + RequestBody: tc.ServerCapability{Name: "foo", Description: "foo servers"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, "BAD REQUEST when INVALID NAME": { ClientSession: TOSession, - RequestBody: tc.ServerCapability{Name: "b@dname"}, + RequestBody: tc.ServerCapability{Name: "b@dname", Description: "Server Capability"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, }, @@ -70,7 +70,7 @@ func TestServerCapabilities(t *testing.T) { "OK when VALID request": { ClientSession: TOSession, RequestOpts: client.RequestOptions{QueryParameters: url.Values{"name": {"blah"}}}, - RequestBody: tc.ServerCapability{Name: "newname"}, + RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, Expectations: utils.CkRequest(utils.NoError(), utils.HasStatus(http.StatusOK), validateServerCapabilitiesUpdateFields(map[string]interface{}{"Name": "newname"}), validateSSCFieldsOnServerCapabilityUpdate("newname", map[string]interface{}{"ServerCapability": "newname"})), @@ -78,7 +78,7 @@ func TestServerCapabilities(t *testing.T) { "BAD REQUEST when NAME DOESNT EXIST": { ClientSession: TOSession, RequestOpts: client.RequestOptions{QueryParameters: url.Values{"name": {"invalid"}}}, - RequestBody: tc.ServerCapability{Name: "newname"}, + RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, "PRECONDITION FAILED when updating with IMS & IUS Headers": { @@ -87,7 +87,7 @@ func TestServerCapabilities(t *testing.T) { QueryParameters: url.Values{"name": {"disk"}}, Header: http.Header{rfc.IfUnmodifiedSince: {currentTimeRFC}}, }, - RequestBody: tc.ServerCapability{Name: "newname"}, + RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusPreconditionFailed)), }, "PRECONDITION FAILED when updating with IFMATCH ETAG Header": { @@ -96,7 +96,7 @@ func TestServerCapabilities(t *testing.T) { QueryParameters: url.Values{"name": {"disk"}}, Header: http.Header{rfc.IfMatch: {rfc.ETag(currentTime)}}, }, - RequestBody: tc.ServerCapability{Name: "newname"}, + RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusPreconditionFailed)), }, }, diff --git a/traffic_ops/testing/api/v4/tc-fixtures.json b/traffic_ops/testing/api/v4/tc-fixtures.json index f0d73e79c5..f6ba73db48 100644 --- a/traffic_ops/testing/api/v4/tc-fixtures.json +++ b/traffic_ops/testing/api/v4/tc-fixtures.json @@ -5519,22 +5519,28 @@ ], "serverCapabilities": [ { - "name": "foo" + "name": "foo", + "description": "server capability foo" }, { - "name": "bar" + "name": "bar", + "description": "server capability bar" }, { - "name": "ram" + "name": "ram", + "description": "server capability ram" }, { - "name": "disk" + "name": "disk", + "description": "server capability disk" }, { - "name": "asdf" + "name": "asdf", + "description": "server capability asdf" }, { - "name": "blah" + "name": "blah", + "description": "server capability blah" } ], "serverServerCapabilities": [ diff --git a/traffic_ops/testing/api/v5/server_capabilities_test.go b/traffic_ops/testing/api/v5/server_capabilities_test.go index a1b9f899f3..db5f7b7e33 100644 --- a/traffic_ops/testing/api/v5/server_capabilities_test.go +++ b/traffic_ops/testing/api/v5/server_capabilities_test.go @@ -57,12 +57,12 @@ func TestServerCapabilities(t *testing.T) { "POST": { "BAD REQUEST when ALREADY EXISTS": { ClientSession: TOSession, - RequestBody: tc.ServerCapability{Name: "foo"}, + RequestBody: tc.ServerCapability{Name: "foo", Description: "foo servers"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, "BAD REQUEST when INVALID NAME": { ClientSession: TOSession, - RequestBody: tc.ServerCapability{Name: "b@dname"}, + RequestBody: tc.ServerCapability{Name: "b@dname", Description: "Server Capability"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, }, @@ -70,7 +70,7 @@ func TestServerCapabilities(t *testing.T) { "OK when VALID request": { ClientSession: TOSession, RequestOpts: client.RequestOptions{QueryParameters: url.Values{"name": {"blah"}}}, - RequestBody: tc.ServerCapability{Name: "newname"}, + RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, Expectations: utils.CkRequest(utils.NoError(), utils.HasStatus(http.StatusOK), validateServerCapabilitiesUpdateFields(map[string]interface{}{"Name": "newname"}), validateSSCFieldsOnServerCapabilityUpdate("newname", map[string]interface{}{"ServerCapability": "newname"})), @@ -78,7 +78,7 @@ func TestServerCapabilities(t *testing.T) { "BAD REQUEST when NAME DOESNT EXIST": { ClientSession: TOSession, RequestOpts: client.RequestOptions{QueryParameters: url.Values{"name": {"invalid"}}}, - RequestBody: tc.ServerCapability{Name: "newname"}, + RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, "PRECONDITION FAILED when updating with IMS & IUS Headers": { @@ -87,7 +87,7 @@ func TestServerCapabilities(t *testing.T) { QueryParameters: url.Values{"name": {"disk"}}, Header: http.Header{rfc.IfUnmodifiedSince: {currentTimeRFC}}, }, - RequestBody: tc.ServerCapability{Name: "newname"}, + RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusPreconditionFailed)), }, "PRECONDITION FAILED when updating with IFMATCH ETAG Header": { @@ -96,7 +96,7 @@ func TestServerCapabilities(t *testing.T) { QueryParameters: url.Values{"name": {"disk"}}, Header: http.Header{rfc.IfMatch: {rfc.ETag(currentTime)}}, }, - RequestBody: tc.ServerCapability{Name: "newname"}, + RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusPreconditionFailed)), }, }, diff --git a/traffic_ops/testing/api/v5/tc-fixtures.json b/traffic_ops/testing/api/v5/tc-fixtures.json index 18dc10c256..8df76f8d48 100644 --- a/traffic_ops/testing/api/v5/tc-fixtures.json +++ b/traffic_ops/testing/api/v5/tc-fixtures.json @@ -5431,22 +5431,28 @@ ], "serverCapabilities": [ { - "name": "foo" + "name": "foo", + "description": "server capability foo" }, { - "name": "bar" + "name": "bar", + "description": "server capability bar" }, { - "name": "ram" + "name": "ram", + "description": "server capability ram" }, { - "name": "disk" + "name": "disk", + "description": "server capability disk" }, { - "name": "asdf" + "name": "asdf", + "description": "server capability asdf" }, { - "name": "blah" + "name": "blah", + "description": "server capability blah" } ], "serverServerCapabilities": [ diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index cd4f122d5e..c7ebb06ef8 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -45,10 +45,12 @@ func (v *TOServerCapability) NewReadObj() interface{} { return &tc.ServerC func (v *TOServerCapability) InsertQuery() string { return ` INSERT INTO server_capability ( - name + name, + description ) VALUES ( - :name + :name, + :description ) RETURNING last_updated ` @@ -58,6 +60,7 @@ func (v *TOServerCapability) SelectQuery() string { return ` SELECT name, + description, last_updated FROM server_capability sc @@ -67,9 +70,10 @@ FROM func (v *TOServerCapability) updateQuery() string { return ` UPDATE server_capability sc SET - name = $1 -WHERE sc.name = $2 -RETURNING sc.name, sc.last_updated + name = $1, + description = $2 +WHERE sc.name = $3 +RETURNING sc.name, sc.description, sc.last_updated ` } @@ -110,7 +114,8 @@ func (v *TOServerCapability) GetType() string { func (v *TOServerCapability) Validate() (error, error) { rule := validation.NewStringRule(tovalidate.IsAlphanumericUnderscoreDash, "must consist of only alphanumeric, dash, or underscore characters") errs := validation.Errors{ - "name": validation.Validate(v.Name, validation.Required, rule), + "name": validation.Validate(v.Name, validation.Required, rule), + "description": validation.Validate(v.Description, validation.Required), } return util.JoinErrs(tovalidate.ToErrors(errs)), nil } @@ -136,14 +141,14 @@ func (v *TOServerCapability) Update(h http.Header) (error, error, int) { } // udpate server capability name - rows, err := v.ReqInfo.Tx.Query(v.updateQuery(), v.RequestedName, v.Name) + rows, err := v.ReqInfo.Tx.Query(v.updateQuery(), v.RequestedName, v.Description, v.Name) if err != nil { return nil, fmt.Errorf("server capability update: error setting the name for server capability %v: %v", v.Name, err.Error()), http.StatusInternalServerError } defer log.Close(rows, "unable to close DB connection") for rows.Next() { - err = rows.Scan(&v.Name, &v.LastUpdated) + err = rows.Scan(&v.Name, &v.Description, &v.LastUpdated) if err != nil { return api.ParseDBError(err) } diff --git a/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html b/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html index f2875fda32..4469f249ce 100644 --- a/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html +++ b/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html @@ -41,6 +41,14 @@ +
+ +
+ + Required + +
+
diff --git a/traffic_portal/app/src/common/modules/table/serverCapabilities/table.serverCapabilities.tpl.html b/traffic_portal/app/src/common/modules/table/serverCapabilities/table.serverCapabilities.tpl.html index 130cd308b5..7375a2e93e 100644 --- a/traffic_portal/app/src/common/modules/table/serverCapabilities/table.serverCapabilities.tpl.html +++ b/traffic_portal/app/src/common/modules/table/serverCapabilities/table.serverCapabilities.tpl.html @@ -34,11 +34,13 @@ Name + Description {{::sc.name}} + {{::sc.description}} diff --git a/traffic_portal/test/integration/Data/servercapabilities.ts b/traffic_portal/test/integration/Data/servercapabilities.ts index 9ec2c40dfb..1a8ece5770 100644 --- a/traffic_portal/test/integration/Data/servercapabilities.ts +++ b/traffic_portal/test/integration/Data/servercapabilities.ts @@ -19,8 +19,9 @@ interface Removal { - description: string; + caseDescription: string; name: string; + description: string; validationMessage: string; } @@ -47,67 +48,75 @@ export const serverCapabilities = { ], check: [ { - description: "check CSV link from Server Capabilities page", + caseDescription: "check CSV link from Server Capabilities page", Name: "Export as CSV" } ], add: [ { - description: "can create a server capability", + caseDescription: "can create a server capability", name: "TP_SC", + description: "Server Capability", validationMessage: "server capability was created." }, { - description: "can create multiple server capabilities", + caseDescription: "can create multiple server capabilities", name: "TP_SC_2", + description: "Server Capability 2", validationMessage: "server capability was created." }, { - description: "can create multiple server capabilities", + caseDescription: "can create multiple server capabilities", name: "TP_SC_3", + description: "Server Capability 3", validationMessage: "server capability was created." }, { - description: "can handle creating existing server capability", + caseDescription: "can handle creating existing server capability", name: "TP_SC_2", + description: "Server Capability 2", validationMessage: "server_capability name 'TP_SC_2' already exists." }, { - description: "can handle invalid period in server capability", + caseDescription: "can handle invalid period in server capability", name: "TP.AUTOMATED", + description: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - description: "can handle invalid space in server capability", + caseDescription: "can handle invalid space in server capability", name: "TP AUTOMATED", + description: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - description: "can handle invalid character in server capability", + caseDescription: "can handle invalid character in server capability", name: "TP#AUTOMATED", + description: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - description: "can handle an empty text field", + caseDescription: "can handle an empty text field", name: "", + description: "", validationMessage: "Required" } ], remove: [ { - description: "can delete a server capability", + caseDescription: "can delete a server capability", invalid: false, name: "TP_SC", validationMessage: "server capability was deleted." }, { - description: "can handle an invalid delete entry", + caseDescription: "can handle an invalid delete entry", invalid: true, name: "TP_SC_2", invalidName: "TP_AUTOMATED" }, { - description: "can delete multiple server capabilities", + caseDescription: "can delete multiple server capabilities", invalid: false, name: "TP_SC_2", validationMessage: "server capability was deleted." @@ -124,20 +133,21 @@ export const serverCapabilities = { ], check: [ { - description: "check CSV link from Server Capabilities page", + caseDescription: "check CSV link from Server Capabilities page", Name: "Export as CSV" } ], add: [ { - description: "can handle readonly role creating a server capability", + caseDescription: "can handle readonly role creating a server capability", name: "TP_SC", + description: "Server Capability", validationMessage: "missing required Permissions: SERVER-CAPABILITY:CREATE" } ], remove: [ { - description: "can handle readonly role deleting a server capability", + caseDescription: "can handle readonly role deleting a server capability", invalid: false, name: "TP_SC_3", validationMessage: "missing required Permissions: SERVER-CAPABILITY:DELETE" @@ -154,68 +164,75 @@ export const serverCapabilities = { ], check: [ { - description: "check CSV link from Server Capabilities page", + caseDescription: "check CSV link from Server Capabilities page", Name: "Export as CSV" } ], add: [ { - description: "can create a server capability", + caseDescription: "can create a server capability", name: "TP_SC", + description: "Server Capability", validationMessage: "server capability was created." }, { - description: "can create multiple server capabilities", + caseDescription: "can create multiple server capabilities", name: "TP_SC_2", + description: "Server Capability 2", validationMessage: "server capability was created." }, { - description: "can handle creating existing server capability", + caseDescription: "can handle creating existing server capability", name: "TP_SC_2", + description: "Server Capability 2", validationMessage: "server_capability name 'TP_SC_2' already exists." }, { - description: "can handle invalid period in server capability", + caseDescription: "can handle invalid period in server capability", name: "TP.AUTOMATED", + description: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - description: "can handle invalid space in server capability", + caseDescription: "can handle invalid space in server capability", name: "TP AUTOMATED", + description: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - description: "can handle invalid character in server capability", + caseDescription: "can handle invalid character in server capability", name: "TP#AUTOMATED", + description: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - description: "can handle an empty text field", + caseDescription: "can handle an empty text field", name: "", + description: "", validationMessage: "Required" } ], remove: [ { - description: "can delete a server capability", + caseDescription: "can delete a server capability", name: "TP_SC", invalid: false, validationMessage: "server capability was deleted." }, { - description: "can handle an invalid delete entry", + caseDescription: "can handle an invalid delete entry", name: "TP_SC_2", invalid: true, invalidName: "TP_AUTOMATED" }, { - description: "can delete multiple server capabilities", + caseDescription: "can delete multiple server capabilities", name: "TP_SC_2", invalid: false, validationMessage: "server capability was deleted." }, { - description: "can delete multiple server capabilities", + caseDescription: "can delete multiple server capabilities", name: "TP_SC_3", invalid: false, validationMessage: "server capability was deleted." diff --git a/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts b/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts index dc9f92f722..6b42716458 100644 --- a/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts +++ b/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts @@ -40,26 +40,26 @@ serverCapabilities.tests.forEach(serverCapabilitiesData => { await serverCapabilitiesPage.OpenServerCapabilityPage(); }); serverCapabilitiesData.check.forEach(check => { - it(check.description, async () => { + it(check.caseDescription, async () => { expect(await serverCapabilitiesPage.CheckCSV(check.Name)).toBe(true); await serverCapabilitiesPage.OpenServerCapabilityPage(); }); }); serverCapabilitiesData.add.forEach(add => { - it(add.description, async () => { + it(add.caseDescription, async () => { expect(await serverCapabilitiesPage.CreateServerCapabilities(add.name, add.validationMessage)).toBe(true); await serverCapabilitiesPage.OpenServerCapabilityPage(); }); }); serverCapabilitiesData.remove.forEach(remove => { if (remove.invalid) { - it(remove.description, async () => { + it(remove.caseDescription, async () => { await serverCapabilitiesPage.SearchServerCapabilities(remove.name) expect(await serverCapabilitiesPage.DeleteServerCapabilities(remove.invalidName, remove.validationMessage)).toBe(false); await serverCapabilitiesPage.OpenServerCapabilityPage(); }); } else { - it(remove.description, async () => { + it(remove.caseDescription, async () => { await serverCapabilitiesPage.SearchServerCapabilities(remove.name) expect(await serverCapabilitiesPage.DeleteServerCapabilities(remove.name, remove.validationMessage)).toBe(true); await serverCapabilitiesPage.OpenServerCapabilityPage(); From 242fc9f60d34564ed48e80ccfd786020ef654de6 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Mon, 21 Nov 2022 18:27:24 -0700 Subject: [PATCH 02/21] Added description field to server capabilities docs --- docs/source/api/v3/server_capabilities.rst | 8 +++++++- docs/source/api/v4/server_capabilities.rst | 14 ++++++++++++-- docs/source/api/v5/server_capabilities.rst | 14 ++++++++++++-- 3 files changed, 31 insertions(+), 5 deletions(-) diff --git a/docs/source/api/v3/server_capabilities.rst b/docs/source/api/v3/server_capabilities.rst index de8a883c17..3b58106cff 100644 --- a/docs/source/api/v3/server_capabilities.rst +++ b/docs/source/api/v3/server_capabilities.rst @@ -49,6 +49,7 @@ Request Structure Response Structure ------------------ :name: The name of this :term:`Server Capability` +:description: The description of this :term:`Server Capability` :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -70,6 +71,7 @@ Response Structure "response": [ { "name": "RAM", + "description": "ram server capability", "lastUpdated": "2019-10-07 20:38:24+00" } ] @@ -86,6 +88,7 @@ Create a new :term:`Server Capability`. Request Structure ----------------- :name: The name of the :term:`Server Capability` +:description: The description of this :term:`Server Capability` .. code-block:: http :caption: Request Example @@ -99,12 +102,14 @@ Request Structure Content-Type: application/json { - "name": "RAM" + "name": "RAM", + "description": "ram server capability", } Response Structure ------------------ :name: The name of this :term:`Server Capability` +:description: The description of this :term:`Server Capability` :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -131,6 +136,7 @@ Response Structure ], "response": { "name": "RAM", + "description": "ram server capability", "lastUpdated": "2019-10-07 22:10:00+00" } } diff --git a/docs/source/api/v4/server_capabilities.rst b/docs/source/api/v4/server_capabilities.rst index 2f8915ea9d..3d6a09560b 100644 --- a/docs/source/api/v4/server_capabilities.rst +++ b/docs/source/api/v4/server_capabilities.rst @@ -50,6 +50,7 @@ Request Structure Response Structure ------------------ :name: The name of this :term:`Server Capability` +:description: The description of this :term:`Server Capability` :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -71,6 +72,7 @@ Response Structure "response": [ { "name": "RAM", + "description": "ram server capability", "lastUpdated": "2019-10-07 20:38:24+00" } ] @@ -88,6 +90,7 @@ Create a new :term:`Server Capability`. Request Structure ----------------- :name: The name of the :term:`Server Capability` +:description: The description of this :term:`Server Capability` .. code-block:: http :caption: Request Example @@ -101,12 +104,14 @@ Request Structure Content-Type: application/json { - "name": "RAM" + "name": "RAM", + "description": "ram server capability", } Response Structure ------------------ :name: The name of this :term:`Server Capability` +:description: The description of this :term:`Server Capability` :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -133,6 +138,7 @@ Response Structure ], "response": { "name": "RAM", + "description": "ram server capability", "lastUpdated": "2019-10-07 22:10:00+00" } } @@ -149,6 +155,7 @@ Update an existing :term:`Server Capability`. Request Structure ----------------- :name: The name of the :term:`Server Capability` +:description: The description of this :term:`Server Capability` .. code-block:: http :caption: Request Example @@ -162,12 +169,14 @@ Request Structure Content-Type: application/json { - "name": "HDD" + "name": "HDD", + "description": "HDD server capability" } Response Structure ------------------ :name: The name of this :term:`Server Capability` +:description: The description of this :term:`Server Capability` :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -194,6 +203,7 @@ Response Structure ], "response": { "name": "HDD", + "description": "HDD server capability", "lastUpdated": "2021-03-03 21:22:08+00" } } diff --git a/docs/source/api/v5/server_capabilities.rst b/docs/source/api/v5/server_capabilities.rst index a6d99a6145..4827ca8ad7 100644 --- a/docs/source/api/v5/server_capabilities.rst +++ b/docs/source/api/v5/server_capabilities.rst @@ -50,6 +50,7 @@ Request Structure Response Structure ------------------ :name: The name of this :term:`Server Capability` +:description: The description of this :term:`Server Capability` :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -71,6 +72,7 @@ Response Structure "response": [ { "name": "RAM", + "description": "ram server capability", "lastUpdated": "2019-10-07 20:38:24+00" } ] @@ -88,6 +90,7 @@ Create a new :term:`Server Capability`. Request Structure ----------------- :name: The name of the :term:`Server Capability` +:description: The description of this :term:`Server Capability` .. code-block:: http :caption: Request Example @@ -101,12 +104,14 @@ Request Structure Content-Type: application/json { - "name": "RAM" + "name": "RAM", + "description": "ram server capability", } Response Structure ------------------ :name: The name of this :term:`Server Capability` +:description: The description of this :term:`Server Capability` :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -133,6 +138,7 @@ Response Structure ], "response": { "name": "RAM", + "description": "ram server capability", "lastUpdated": "2019-10-07 22:10:00+00" } } @@ -149,6 +155,7 @@ Update an existing :term:`Server Capability`. Request Structure ----------------- :name: The name of the :term:`Server Capability` +:description: The description of this :term:`Server Capability` .. code-block:: http :caption: Request Example @@ -162,12 +169,14 @@ Request Structure Content-Type: application/json { - "name": "HDD" + "name": "HDD", + "description": "HDD server capability" } Response Structure ------------------ :name: The name of this :term:`Server Capability` +:description: The description of this :term:`Server Capability` :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -194,6 +203,7 @@ Response Structure ], "response": { "name": "HDD", + "description": "HDD server capability", "lastUpdated": "2021-03-03 21:22:08+00" } } From ca34bf2df24b1cb06eb83d7795c8d29fcaac9e97 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Tue, 22 Nov 2022 11:02:58 -0700 Subject: [PATCH 03/21] Removed required checks for description field --- .../traffic_ops_golang/servercapability/servercapability.go | 3 +-- .../form/serverCapability/form.serverCapability.tpl.html | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index c7ebb06ef8..9003efbb4d 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -114,8 +114,7 @@ func (v *TOServerCapability) GetType() string { func (v *TOServerCapability) Validate() (error, error) { rule := validation.NewStringRule(tovalidate.IsAlphanumericUnderscoreDash, "must consist of only alphanumeric, dash, or underscore characters") errs := validation.Errors{ - "name": validation.Validate(v.Name, validation.Required, rule), - "description": validation.Validate(v.Description, validation.Required), + "name": validation.Validate(v.Name, validation.Required, rule), } return util.JoinErrs(tovalidate.ToErrors(errs)), nil } diff --git a/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html b/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html index 4469f249ce..395383d23c 100644 --- a/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html +++ b/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html @@ -44,8 +44,7 @@
- - Required +
From 92a977fb729e49a8e39b088c0b0691c4c23ca45c Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Mon, 5 Dec 2022 11:06:59 -0700 Subject: [PATCH 04/21] Addressed review comments. --- docs/source/api/v3/server_capabilities.rst | 8 +------- docs/source/api/v4/server_capabilities.rst | 15 +++++++++++++++ lib/go-tc/server_capabilities.go | 7 ++++++- ...12116304800_add_description_in_sc_table.up.sql | 2 +- traffic_ops/traffic_ops_golang/routing/routes.go | 6 ++++++ .../form.serverCapability.tpl.html | 7 +++---- 6 files changed, 32 insertions(+), 13 deletions(-) diff --git a/docs/source/api/v3/server_capabilities.rst b/docs/source/api/v3/server_capabilities.rst index 3b58106cff..de8a883c17 100644 --- a/docs/source/api/v3/server_capabilities.rst +++ b/docs/source/api/v3/server_capabilities.rst @@ -49,7 +49,6 @@ Request Structure Response Structure ------------------ :name: The name of this :term:`Server Capability` -:description: The description of this :term:`Server Capability` :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -71,7 +70,6 @@ Response Structure "response": [ { "name": "RAM", - "description": "ram server capability", "lastUpdated": "2019-10-07 20:38:24+00" } ] @@ -88,7 +86,6 @@ Create a new :term:`Server Capability`. Request Structure ----------------- :name: The name of the :term:`Server Capability` -:description: The description of this :term:`Server Capability` .. code-block:: http :caption: Request Example @@ -102,14 +99,12 @@ Request Structure Content-Type: application/json { - "name": "RAM", - "description": "ram server capability", + "name": "RAM" } Response Structure ------------------ :name: The name of this :term:`Server Capability` -:description: The description of this :term:`Server Capability` :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -136,7 +131,6 @@ Response Structure ], "response": { "name": "RAM", - "description": "ram server capability", "lastUpdated": "2019-10-07 22:10:00+00" } } diff --git a/docs/source/api/v4/server_capabilities.rst b/docs/source/api/v4/server_capabilities.rst index 3d6a09560b..a2472f83ad 100644 --- a/docs/source/api/v4/server_capabilities.rst +++ b/docs/source/api/v4/server_capabilities.rst @@ -51,6 +51,9 @@ Response Structure ------------------ :name: The name of this :term:`Server Capability` :description: The description of this :term:`Server Capability` + + .. versionadded:: 4.1 + :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -92,6 +95,9 @@ Request Structure :name: The name of the :term:`Server Capability` :description: The description of this :term:`Server Capability` + .. versionadded:: 4.1 + + .. code-block:: http :caption: Request Example @@ -112,6 +118,9 @@ Response Structure ------------------ :name: The name of this :term:`Server Capability` :description: The description of this :term:`Server Capability` + + .. versionadded:: 4.1 + :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http @@ -157,6 +166,9 @@ Request Structure :name: The name of the :term:`Server Capability` :description: The description of this :term:`Server Capability` + .. versionadded:: 4.1 + + .. code-block:: http :caption: Request Example @@ -177,6 +189,9 @@ Response Structure ------------------ :name: The name of this :term:`Server Capability` :description: The description of this :term:`Server Capability` + + .. versionadded:: 4.1 + :lastUpdated: The date and time at which this :term:`Server Capability` was last updated, in ISO-like format .. code-block:: http diff --git a/lib/go-tc/server_capabilities.go b/lib/go-tc/server_capabilities.go index 7050902435..8f758d9461 100644 --- a/lib/go-tc/server_capabilities.go +++ b/lib/go-tc/server_capabilities.go @@ -28,10 +28,15 @@ type ServerCapabilitiesResponse struct { // ServerCapability contains information about a given ServerCapability in Traffic Ops. type ServerCapability struct { Name string `json:"name" db:"name"` - Description string `json:"description" db:"description"` LastUpdated *TimeNoMod `json:"lastUpdated" db:"last_updated"` } +// ServerCapabilityV41 contains information (in-addition to description) about a given ServerCapability in Traffic Ops. +type ServerCapabilityV41 struct { + ServerCapability + Description string `json:"description" db:"description"` +} + // ServerCapabilityDetailResponse contains the result data from a POST /server_capabilities request. type ServerCapabilityDetailResponse struct { Response ServerCapability `json:"response"` diff --git a/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.up.sql b/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.up.sql index ef929918be..1713df8842 100644 --- a/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.up.sql +++ b/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.up.sql @@ -15,4 +15,4 @@ * the License. */ -ALTER TABLE public.server_capability ADD COLUMN IF NOT EXISTS description text DEFAULT NULL; +ALTER TABLE public.server_capability ADD COLUMN IF NOT EXISTS description text NOT NULL DEFAULT ''; diff --git a/traffic_ops/traffic_ops_golang/routing/routes.go b/traffic_ops/traffic_ops_golang/routing/routes.go index 87703283d0..84280d0268 100644 --- a/traffic_ops/traffic_ops_golang/routing/routes.go +++ b/traffic_ops/traffic_ops_golang/routing/routes.go @@ -535,6 +535,12 @@ func Routes(d ServerData) ([]Route, http.Handler, error) { {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodPost, Path: `multiple_servers_capabilities/?$`, Handler: server.AssignMultipleServersCapabilities, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER:READ", "SERVER:CREATE", "SERVER-CAPABILITY:READ", "SERVER-CAPABILITY:CREATE"}, Authenticated: Authenticated, Middlewares: nil, ID: 40792419258}, {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodDelete, Path: `multiple_servers_capabilities/?$`, Handler: server.DeleteMultipleServersCapabilities, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER:READ", "SERVER:DELETE", "SERVER-CAPABILITY:READ", "SERVER-CAPABILITY:DELETE"}, Authenticated: Authenticated, Middlewares: nil, ID: 40792419278}, + //Server Capability + {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodGet, Path: `server_capabilities$`, Handler: api.ReadHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelReadOnly, RequiredPermissions: []string{"SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 4104073912}, + {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodPost, Path: `server_capabilities$`, Handler: api.CreateHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:CREATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 40744707025}, + {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodPut, Path: `server_capabilities$`, Handler: api.UpdateHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:UPDATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 425437701023}, + {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodDelete, Path: `server_capabilities$`, Handler: api.DeleteHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:DELETE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 4364150314}, + // CDNI integration {Version: api.Version{Major: 4, Minor: 0}, Method: http.MethodGet, Path: `OC/FCI/advertisement/?$`, Handler: cdni.GetCapabilities, RequiredPrivLevel: auth.PrivLevelReadOnly, RequiredPermissions: []string{"CDNI-CAPACITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 541357729077}, {Version: api.Version{Major: 4, Minor: 0}, Method: http.MethodPut, Path: `OC/CI/configuration/?$`, Handler: cdni.PutConfiguration, RequiredPrivLevel: auth.PrivLevelReadOnly, RequiredPermissions: []string{"CDNI-CAPACITY:UPDATE"}, Authenticated: Authenticated, Middlewares: nil, ID: 541357729078}, diff --git a/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html b/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html index 395383d23c..0d8c85d548 100644 --- a/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html +++ b/traffic_portal/app/src/common/modules/form/serverCapability/form.serverCapability.tpl.html @@ -41,11 +41,10 @@
-
- +
+
- - +
From 3acd2b641dc1c5eb1e53b4275150fcc59dcad4eb Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Wed, 7 Dec 2022 12:44:36 -0700 Subject: [PATCH 05/21] Updated cruder functionality and routes --- traffic_ops/testing/api/v3/tc-fixtures.json | 18 +-- traffic_ops/testing/api/v4/tc-fixtures.json | 18 +-- .../traffic_ops_golang/routing/routes.go | 13 +- .../servercapability/servercapability.go | 141 ++++++++++++++++-- 4 files changed, 147 insertions(+), 43 deletions(-) diff --git a/traffic_ops/testing/api/v3/tc-fixtures.json b/traffic_ops/testing/api/v3/tc-fixtures.json index 66eaa1ef91..f392b2d5f1 100644 --- a/traffic_ops/testing/api/v3/tc-fixtures.json +++ b/traffic_ops/testing/api/v3/tc-fixtures.json @@ -4822,28 +4822,22 @@ ], "serverCapabilities": [ { - "name": "foo", - "description": "server capability foo" + "name": "foo" }, { - "name": "bar", - "description": "server capability bar" + "name": "bar" }, { - "name": "ram", - "description": "server capability ram" + "name": "ram" }, { - "name": "disk", - "description": "server capability disk" + "name": "disk" }, { - "name": "asdf", - "description": "server capability asdf" + "name": "asdf" }, { - "name": "blah", - "description": "server capability blah" + "name": "blah" } ], "serverServerCapabilities": [ diff --git a/traffic_ops/testing/api/v4/tc-fixtures.json b/traffic_ops/testing/api/v4/tc-fixtures.json index f6ba73db48..f0d73e79c5 100644 --- a/traffic_ops/testing/api/v4/tc-fixtures.json +++ b/traffic_ops/testing/api/v4/tc-fixtures.json @@ -5519,28 +5519,22 @@ ], "serverCapabilities": [ { - "name": "foo", - "description": "server capability foo" + "name": "foo" }, { - "name": "bar", - "description": "server capability bar" + "name": "bar" }, { - "name": "ram", - "description": "server capability ram" + "name": "ram" }, { - "name": "disk", - "description": "server capability disk" + "name": "disk" }, { - "name": "asdf", - "description": "server capability asdf" + "name": "asdf" }, { - "name": "blah", - "description": "server capability blah" + "name": "blah" } ], "serverServerCapabilities": [ diff --git a/traffic_ops/traffic_ops_golang/routing/routes.go b/traffic_ops/traffic_ops_golang/routing/routes.go index 84280d0268..016521d6b0 100644 --- a/traffic_ops/traffic_ops_golang/routing/routes.go +++ b/traffic_ops/traffic_ops_golang/routing/routes.go @@ -324,9 +324,9 @@ func Routes(d ServerData) ([]Route, http.Handler, error) { {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodDelete, Path: `servers/{id}$`, Handler: server.Delete, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER:DELETE", "SERVER:READ", "DELIVERY-SERVICE:READ", "CDN:READ", "PHYSICAL-LOCATION:READ", "CACHE-GROUP:READ", "TYPE:READ", "PROFILE:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 49232223331}, //Server Capability - {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodGet, Path: `server_capabilities$`, Handler: api.ReadHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelReadOnly, RequiredPermissions: []string{"SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 41040739131}, - {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodPost, Path: `server_capabilities$`, Handler: api.CreateHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:CREATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 407447070831}, - {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodPut, Path: `server_capabilities$`, Handler: api.UpdateHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:UPDATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 425437701091}, + {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodGet, Path: `server_capabilities$`, Handler: servercapability.GetServerCapability, RequiredPrivLevel: auth.PrivLevelReadOnly, RequiredPermissions: []string{"SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 41040739131}, + {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodPost, Path: `server_capabilities$`, Handler: servercapability.CreateServerCapability, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:CREATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 407447070831}, + {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodPut, Path: `server_capabilities$`, Handler: servercapability.UpdateServerCapability, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:UPDATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 425437701091}, {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodDelete, Path: `server_capabilities$`, Handler: api.DeleteHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:DELETE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 43641503831}, {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodPost, Path: `multiple_servers_capabilities/?$`, Handler: server.AssignMultipleServersCapabilities, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER:READ", "SERVER:CREATE", "SERVER-CAPABILITY:READ", "SERVER-CAPABILITY:CREATE"}, Authenticated: Authenticated, Middlewares: nil, ID: 407924192581}, {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodDelete, Path: `multiple_servers_capabilities/?$`, Handler: server.DeleteMultipleServersCapabilities, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER:READ", "SERVER:DELETE", "SERVER-CAPABILITY:READ", "SERVER-CAPABILITY:DELETE"}, Authenticated: Authenticated, Middlewares: nil, ID: 407924192781}, @@ -536,10 +536,9 @@ func Routes(d ServerData) ([]Route, http.Handler, error) { {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodDelete, Path: `multiple_servers_capabilities/?$`, Handler: server.DeleteMultipleServersCapabilities, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER:READ", "SERVER:DELETE", "SERVER-CAPABILITY:READ", "SERVER-CAPABILITY:DELETE"}, Authenticated: Authenticated, Middlewares: nil, ID: 40792419278}, //Server Capability - {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodGet, Path: `server_capabilities$`, Handler: api.ReadHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelReadOnly, RequiredPermissions: []string{"SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 4104073912}, - {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodPost, Path: `server_capabilities$`, Handler: api.CreateHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:CREATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 40744707025}, - {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodPut, Path: `server_capabilities$`, Handler: api.UpdateHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:UPDATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 425437701023}, - {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodDelete, Path: `server_capabilities$`, Handler: api.DeleteHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:DELETE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 4364150314}, + {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodGet, Path: `server_capabilities$`, Handler: servercapability.GetServerCapability, RequiredPrivLevel: auth.PrivLevelReadOnly, RequiredPermissions: []string{"SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 4104073912}, + {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodPost, Path: `server_capabilities$`, Handler: servercapability.CreateServerCapability, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:CREATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 40744707025}, + {Version: api.Version{Major: 4, Minor: 1}, Method: http.MethodPut, Path: `server_capabilities$`, Handler: servercapability.UpdateServerCapability, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:UPDATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 425437701023}, // CDNI integration {Version: api.Version{Major: 4, Minor: 0}, Method: http.MethodGet, Path: `OC/FCI/advertisement/?$`, Handler: cdni.GetCapabilities, RequiredPrivLevel: auth.PrivLevelReadOnly, RequiredPermissions: []string{"CDNI-CAPACITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 541357729077}, diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index 9003efbb4d..24ccb96d6b 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -20,6 +20,8 @@ package servercapability */ import ( + "database/sql" + "encoding/json" "fmt" "net/http" "time" @@ -45,12 +47,10 @@ func (v *TOServerCapability) NewReadObj() interface{} { return &tc.ServerC func (v *TOServerCapability) InsertQuery() string { return ` INSERT INTO server_capability ( - name, - description + name ) VALUES ( - :name, - :description + :name ) RETURNING last_updated ` @@ -60,7 +60,6 @@ func (v *TOServerCapability) SelectQuery() string { return ` SELECT name, - description, last_updated FROM server_capability sc @@ -70,10 +69,9 @@ FROM func (v *TOServerCapability) updateQuery() string { return ` UPDATE server_capability sc SET - name = $1, - description = $2 -WHERE sc.name = $3 -RETURNING sc.name, sc.description, sc.last_updated + name = $1 +WHERE sc.name = $2 +RETURNING sc.name, sc.last_updated ` } @@ -139,15 +137,15 @@ func (v *TOServerCapability) Update(h http.Header) (error, error, int) { return userErr, sysErr, errCode } - // udpate server capability name - rows, err := v.ReqInfo.Tx.Query(v.updateQuery(), v.RequestedName, v.Description, v.Name) + // update server capability name + rows, err := v.ReqInfo.Tx.Query(v.updateQuery(), v.RequestedName, v.Name) if err != nil { return nil, fmt.Errorf("server capability update: error setting the name for server capability %v: %v", v.Name, err.Error()), http.StatusInternalServerError } defer log.Close(rows, "unable to close DB connection") for rows.Next() { - err = rows.Scan(&v.Name, &v.Description, &v.LastUpdated) + err = rows.Scan(&v.Name, &v.LastUpdated) if err != nil { return api.ParseDBError(err) } @@ -155,6 +153,125 @@ func (v *TOServerCapability) Update(h http.Header) (error, error, int) { return nil, nil, http.StatusOK } +func GetServerCapability(w http.ResponseWriter, r *http.Request) { + var sc tc.ServerCapabilityV41 + inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil) + tx := inf.Tx + if userErr != nil || sysErr != nil { + api.HandleErr(w, r, tx.Tx, errCode, userErr, sysErr) + return + } + defer inf.Close() + + // Query Parameters to Database Query column mappings + queryParamsToQueryCols := map[string]dbhelpers.WhereColumnInfo{ + "name": dbhelpers.WhereColumnInfo{Column: "sc.name"}, + } + where, orderBy, pagination, queryValues, errs := dbhelpers.BuildWhereAndOrderByAndPagination(inf.Params, queryParamsToQueryCols) + if len(errs) > 0 { + api.HandleErr(w, r, tx.Tx, http.StatusBadRequest, util.JoinErrs(errs), nil) + return + } + + query := "SELECT name, description, last_updated FROM server_capability sc" + query += where + orderBy + pagination + rows, err := tx.NamedQuery(query, queryValues) + if err != nil { + api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("server capability read: error getting server capability(ies): %v", err.Error())) + } + defer log.Close(rows, "unable to close DB connection") + + var scList []tc.ServerCapabilityV41 + for rows.Next() { + if err = rows.Scan(&sc.Name, &sc.Description, &sc.LastUpdated); err != nil { + api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("error getting server capability(ies): "+err.Error())) + } + scList = append(scList, sc) + } + + api.WriteResp(w, r, scList) + return +} + +func UpdateServerCapability(w http.ResponseWriter, r *http.Request) { + inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil) + if userErr != nil || sysErr != nil { + api.HandleErr(w, r, inf.Tx.Tx, errCode, userErr, sysErr) + return + } + defer inf.Close() + + tx := inf.Tx.Tx + sc, err := readAndValidateJsonStruct(r, inf) + if err != nil { + api.HandleErr(w, r, tx, http.StatusBadRequest, err, nil) + return + } + + //update name and description of a capability + requestedName := inf.Params["name"] + query := `UPDATE server_capability sc SET + name = $1, + description = $2 + WHERE sc.name = $3 + RETURNING sc.name, sc.description, sc.last_updated` + + err = tx.QueryRow(query, sc.Name, sc.Description, requestedName).Scan(&sc.Name, &sc.Description, &sc.LastUpdated) + if err != nil && err != sql.ErrNoRows { + api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) + return + } + alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was updated") + api.WriteAlertsObj(w, r, http.StatusCreated, alerts, sc) + return +} + +func CreateServerCapability(w http.ResponseWriter, r *http.Request) { + inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil) + if userErr != nil || sysErr != nil { + api.HandleErr(w, r, inf.Tx.Tx, errCode, userErr, sysErr) + return + } + defer inf.Close() + tx := inf.Tx.Tx + + sc, err := readAndValidateJsonStruct(r, inf) + if err != nil { + api.HandleErr(w, r, tx, http.StatusBadRequest, err, nil) + return + } + + // create server capability + query := `INSERT INTO server_capability (name, description) VALUES ($1, $2) RETURNING last_updated` + err = tx.QueryRow(query, sc.Name, sc.Description).Scan(&sc.LastUpdated) + if err != nil && err != sql.ErrNoRows { + api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) + return + } + + alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was created") + api.WriteAlertsObj(w, r, http.StatusCreated, alerts, sc) + return +} + +func readAndValidateJsonStruct(r *http.Request, inf *api.APIInfo) (tc.ServerCapabilityV41, error) { + var sc tc.ServerCapabilityV41 + if err := json.NewDecoder(r.Body).Decode(&sc); err != nil { + userErr := fmt.Errorf("error decoding POST request body into ServerCapabilityV41 struct %w", err) + return sc, userErr + } + + // validate JSON body + errs := tovalidate.ToErrors(validation.Errors{ + "name": validation.Validate(sc.Name, validation.Required), + }) + if len(errs) > 0 { + userErr := util.JoinErrs(errs) + return sc, userErr + } + return sc, nil +} + func (v *TOServerCapability) SelectMaxLastUpdatedQuery(where, orderBy, pagination, tableName string) string { return `SELECT max(t) from ( SELECT max(sc.last_updated) as t from server_capability sc ` + where + orderBy + pagination + From 8c3f6927de0443fdcbd9c1512e7da30c8a789f6a Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Wed, 7 Dec 2022 14:32:11 -0700 Subject: [PATCH 06/21] Using description in TP tests and updated sort order in SC table --- .../serverCapabilities/table.serverCapabilities.tpl.html | 2 +- .../integration/PageObjects/ServerCapabilitiesPage.po.ts | 5 ++++- .../test/integration/specs/ServerCapabilities.spec.ts | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/traffic_portal/app/src/common/modules/table/serverCapabilities/table.serverCapabilities.tpl.html b/traffic_portal/app/src/common/modules/table/serverCapabilities/table.serverCapabilities.tpl.html index 7375a2e93e..ae73d1649a 100644 --- a/traffic_portal/app/src/common/modules/table/serverCapabilities/table.serverCapabilities.tpl.html +++ b/traffic_portal/app/src/common/modules/table/serverCapabilities/table.serverCapabilities.tpl.html @@ -38,7 +38,7 @@ - + {{::sc.name}} {{::sc.description}} diff --git a/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts b/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts index 8bba678f4e..dca90bf798 100644 --- a/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts +++ b/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts @@ -26,6 +26,7 @@ export class ServerCapabilitiesPage extends BasePage{ private btnCreateServerCapabilities = element(by.name('createServerCapabilityButton')); private txtSCName = element(by.id("name")) + private txtSCDescription = element(by.id("description")) private searchFilter = element(by.id('serverCapabilitiesTable_filter')).element(by.css('label input')); private btnDelete = element(by.buttonText('Delete')) private txtConfirmCapabilitiesName = element(by.name('confirmWithNameInput')); @@ -41,15 +42,17 @@ export class ServerCapabilitiesPage extends BasePage{ await snp.ClickConfigureMenu(); } - public async CreateServerCapabilities(nameSC: string, outputMessage:string){ + public async CreateServerCapabilities(nameSC: string, descriptionSC: string, outputMessage:string){ let result = false let basePage = new BasePage(); let snp= new SideNavigationPage(); let name = nameSC+this.randomize; + let description = descriptionSC await this.btnCreateServerCapabilities.click(); if(name != this.randomize){ await this.txtSCName.sendKeys(name); } + await this.txtSCDescription.sendKeys(description); if(outputMessage == await(basePage.GetBlankErrorMessage()) || outputMessage == await(basePage.GetSyntaxErrorMessage())) { await snp.NavigateToServerCapabilitiesPage(); result = true; diff --git a/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts b/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts index 6b42716458..e7961bfab3 100644 --- a/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts +++ b/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts @@ -47,7 +47,7 @@ serverCapabilities.tests.forEach(serverCapabilitiesData => { }); serverCapabilitiesData.add.forEach(add => { it(add.caseDescription, async () => { - expect(await serverCapabilitiesPage.CreateServerCapabilities(add.name, add.validationMessage)).toBe(true); + expect(await serverCapabilitiesPage.CreateServerCapabilities(add.name, add.description, add.validationMessage)).toBe(true); await serverCapabilitiesPage.OpenServerCapabilityPage(); }); }); From 51c079811f7ab3460bf4b970b3e6e8628b4d7496 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Wed, 7 Dec 2022 15:05:16 -0700 Subject: [PATCH 07/21] Removed description from v3 --- traffic_ops/testing/api/v3/server_capabilities_test.go | 2 +- .../traffic_ops_golang/servercapability/servercapability.go | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/traffic_ops/testing/api/v3/server_capabilities_test.go b/traffic_ops/testing/api/v3/server_capabilities_test.go index 0be3a6d3da..961c665925 100644 --- a/traffic_ops/testing/api/v3/server_capabilities_test.go +++ b/traffic_ops/testing/api/v3/server_capabilities_test.go @@ -46,7 +46,7 @@ func TestServerCapabilities(t *testing.T) { "POST": { "BAD REQUEST when INVALID NAME": { ClientSession: TOSession, - RequestBody: tc.ServerCapability{Name: "b@dname", Description: "Server Capability"}, + RequestBody: tc.ServerCapability{Name: "b@dname"}, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, }, diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index 24ccb96d6b..888054f98a 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -173,8 +173,8 @@ func GetServerCapability(w http.ResponseWriter, r *http.Request) { return } - query := "SELECT name, description, last_updated FROM server_capability sc" - query += where + orderBy + pagination + selectQuery := "SELECT name, description, last_updated FROM server_capability sc" + query := selectQuery + where + orderBy + pagination rows, err := tx.NamedQuery(query, queryValues) if err != nil { api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("server capability read: error getting server capability(ies): %v", err.Error())) From b78140e1c504361833add983c11f8f75f67a6d22 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Wed, 7 Dec 2022 20:05:56 -0700 Subject: [PATCH 08/21] Updated test in v4/v5 to new struct V41 --- lib/go-tc/server_capabilities.go | 10 +++ .../api/v4/server_capabilities_test.go | 41 +++++++++---- .../testing/api/v4/traffic_control_test.go | 2 +- .../api/v5/server_capabilities_test.go | 42 +++++++++---- .../testing/api/v5/traffic_control_test.go | 2 +- .../servercapability/servercapability.go | 61 ++++++++++++++----- traffic_ops/v4-client/servercapability.go | 12 ++-- traffic_ops/v5-client/servercapability.go | 12 ++-- 8 files changed, 128 insertions(+), 54 deletions(-) diff --git a/lib/go-tc/server_capabilities.go b/lib/go-tc/server_capabilities.go index 8f758d9461..9c07d1cc30 100644 --- a/lib/go-tc/server_capabilities.go +++ b/lib/go-tc/server_capabilities.go @@ -25,6 +25,11 @@ type ServerCapabilitiesResponse struct { Alerts } +type ServerCapabilitiesResponseV41 struct { + Response []ServerCapabilityV41 `json:"response"` + Alerts +} + // ServerCapability contains information about a given ServerCapability in Traffic Ops. type ServerCapability struct { Name string `json:"name" db:"name"` @@ -42,3 +47,8 @@ type ServerCapabilityDetailResponse struct { Response ServerCapability `json:"response"` Alerts } + +type ServerCapabilityDetailResponseV41 struct { + Response ServerCapabilityV41 `json:"response"` + Alerts +} diff --git a/traffic_ops/testing/api/v4/server_capabilities_test.go b/traffic_ops/testing/api/v4/server_capabilities_test.go index 118954e4fb..c19fa171ba 100644 --- a/traffic_ops/testing/api/v4/server_capabilities_test.go +++ b/traffic_ops/testing/api/v4/server_capabilities_test.go @@ -36,7 +36,7 @@ func TestServerCapabilities(t *testing.T) { currentTime := time.Now().UTC().Add(-15 * time.Second) currentTimeRFC := currentTime.Format(time.RFC1123) - methodTests := utils.TestCase[client.Session, client.RequestOptions, tc.ServerCapability]{ + methodTests := utils.TestCase[client.Session, client.RequestOptions, tc.ServerCapabilityV41]{ "GET": { "OK when VALID request": { ClientSession: TOSession, @@ -57,20 +57,28 @@ func TestServerCapabilities(t *testing.T) { "POST": { "BAD REQUEST when ALREADY EXISTS": { ClientSession: TOSession, - RequestBody: tc.ServerCapability{Name: "foo", Description: "foo servers"}, - Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "foo"}, + Description: "foo servers", + }, + Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, "BAD REQUEST when INVALID NAME": { ClientSession: TOSession, - RequestBody: tc.ServerCapability{Name: "b@dname", Description: "Server Capability"}, - Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "b@dname"}, + Description: "Server Capability", + }, + Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, }, "PUT": { "OK when VALID request": { ClientSession: TOSession, RequestOpts: client.RequestOptions{QueryParameters: url.Values{"name": {"blah"}}}, - RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "newname"}, + Description: "Server Capability for new name"}, Expectations: utils.CkRequest(utils.NoError(), utils.HasStatus(http.StatusOK), validateServerCapabilitiesUpdateFields(map[string]interface{}{"Name": "newname"}), validateSSCFieldsOnServerCapabilityUpdate("newname", map[string]interface{}{"ServerCapability": "newname"})), @@ -78,8 +86,11 @@ func TestServerCapabilities(t *testing.T) { "BAD REQUEST when NAME DOESNT EXIST": { ClientSession: TOSession, RequestOpts: client.RequestOptions{QueryParameters: url.Values{"name": {"invalid"}}}, - RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, - Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "newname"}, + Description: "Server Capability for new name", + }, + Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, "PRECONDITION FAILED when updating with IMS & IUS Headers": { ClientSession: TOSession, @@ -87,7 +98,10 @@ func TestServerCapabilities(t *testing.T) { QueryParameters: url.Values{"name": {"disk"}}, Header: http.Header{rfc.IfUnmodifiedSince: {currentTimeRFC}}, }, - RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "newname"}, + Description: "Server Capability for new name", + }, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusPreconditionFailed)), }, "PRECONDITION FAILED when updating with IFMATCH ETAG Header": { @@ -96,7 +110,10 @@ func TestServerCapabilities(t *testing.T) { QueryParameters: url.Values{"name": {"disk"}}, Header: http.Header{rfc.IfMatch: {rfc.ETag(currentTime)}}, }, - RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "newname"}, + Description: "Server Capability for new name", + }, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusPreconditionFailed)), }, }, @@ -156,7 +173,7 @@ func TestServerCapabilities(t *testing.T) { func validateServerCapabilitiesUpdateFields(expectedResp map[string]interface{}) utils.CkReqFunc { return func(t *testing.T, _ toclientlib.ReqInf, resp interface{}, _ tc.Alerts, _ error) { assert.RequireNotNil(t, resp, "Expected Server Capabilities response to not be nil.") - serverCapabilitiesResp := resp.(tc.ServerCapability) + serverCapabilitiesResp := resp.(tc.ServerCapabilityV41) for field, expected := range expectedResp { switch field { case "Name": @@ -172,7 +189,7 @@ func validateServerCapabilitiesSort() utils.CkReqFunc { return func(t *testing.T, _ toclientlib.ReqInf, resp interface{}, alerts tc.Alerts, _ error) { assert.RequireNotNil(t, resp, "Expected Server Capabilities response to not be nil.") var serverCapabilityNames []string - serverCapabilitiesResp := resp.([]tc.ServerCapability) + serverCapabilitiesResp := resp.([]tc.ServerCapabilityV41) for _, serverCapability := range serverCapabilitiesResp { serverCapabilityNames = append(serverCapabilityNames, serverCapability.Name) } diff --git a/traffic_ops/testing/api/v4/traffic_control_test.go b/traffic_ops/testing/api/v4/traffic_control_test.go index ddbc8b06a0..f9b1f93c9b 100644 --- a/traffic_ops/testing/api/v4/traffic_control_test.go +++ b/traffic_ops/testing/api/v4/traffic_control_test.go @@ -47,7 +47,7 @@ type TrafficControl struct { Roles []tc.RoleV4 `json:"roles"` Servers []tc.ServerV40 `json:"servers"` ServerServerCapabilities []tc.ServerServerCapability `json:"serverServerCapabilities"` - ServerCapabilities []tc.ServerCapability `json:"serverCapabilities"` + ServerCapabilities []tc.ServerCapabilityV41 `json:"serverCapabilities"` ServiceCategories []tc.ServiceCategory `json:"serviceCategories"` Statuses []tc.StatusNullable `json:"statuses"` StaticDNSEntries []tc.StaticDNSEntry `json:"staticdnsentries"` diff --git a/traffic_ops/testing/api/v5/server_capabilities_test.go b/traffic_ops/testing/api/v5/server_capabilities_test.go index db5f7b7e33..97182eabf7 100644 --- a/traffic_ops/testing/api/v5/server_capabilities_test.go +++ b/traffic_ops/testing/api/v5/server_capabilities_test.go @@ -36,7 +36,7 @@ func TestServerCapabilities(t *testing.T) { currentTime := time.Now().UTC().Add(-15 * time.Second) currentTimeRFC := currentTime.Format(time.RFC1123) - methodTests := utils.TestCase[client.Session, client.RequestOptions, tc.ServerCapability]{ + methodTests := utils.TestCase[client.Session, client.RequestOptions, tc.ServerCapabilityV41]{ "GET": { "OK when VALID request": { ClientSession: TOSession, @@ -57,20 +57,29 @@ func TestServerCapabilities(t *testing.T) { "POST": { "BAD REQUEST when ALREADY EXISTS": { ClientSession: TOSession, - RequestBody: tc.ServerCapability{Name: "foo", Description: "foo servers"}, - Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "foo"}, + Description: "foo servers", + }, + Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, "BAD REQUEST when INVALID NAME": { ClientSession: TOSession, - RequestBody: tc.ServerCapability{Name: "b@dname", Description: "Server Capability"}, - Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "b@dname"}, + Description: "Server Capability", + }, + Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, }, "PUT": { "OK when VALID request": { ClientSession: TOSession, RequestOpts: client.RequestOptions{QueryParameters: url.Values{"name": {"blah"}}}, - RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "newname"}, + Description: "Server Capability for new name", + }, Expectations: utils.CkRequest(utils.NoError(), utils.HasStatus(http.StatusOK), validateServerCapabilitiesUpdateFields(map[string]interface{}{"Name": "newname"}), validateSSCFieldsOnServerCapabilityUpdate("newname", map[string]interface{}{"ServerCapability": "newname"})), @@ -78,8 +87,11 @@ func TestServerCapabilities(t *testing.T) { "BAD REQUEST when NAME DOESNT EXIST": { ClientSession: TOSession, RequestOpts: client.RequestOptions{QueryParameters: url.Values{"name": {"invalid"}}}, - RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, - Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "newname"}, + Description: "Server Capability for new name", + }, + Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusBadRequest)), }, "PRECONDITION FAILED when updating with IMS & IUS Headers": { ClientSession: TOSession, @@ -87,7 +99,10 @@ func TestServerCapabilities(t *testing.T) { QueryParameters: url.Values{"name": {"disk"}}, Header: http.Header{rfc.IfUnmodifiedSince: {currentTimeRFC}}, }, - RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "newname"}, + Description: "Server Capability for new name", + }, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusPreconditionFailed)), }, "PRECONDITION FAILED when updating with IFMATCH ETAG Header": { @@ -96,7 +111,10 @@ func TestServerCapabilities(t *testing.T) { QueryParameters: url.Values{"name": {"disk"}}, Header: http.Header{rfc.IfMatch: {rfc.ETag(currentTime)}}, }, - RequestBody: tc.ServerCapability{Name: "newname", Description: "Server Capability for new name"}, + RequestBody: tc.ServerCapabilityV41{ + ServerCapability: tc.ServerCapability{Name: "newname"}, + Description: "Server Capability for new name", + }, Expectations: utils.CkRequest(utils.HasError(), utils.HasStatus(http.StatusPreconditionFailed)), }, }, @@ -156,7 +174,7 @@ func TestServerCapabilities(t *testing.T) { func validateServerCapabilitiesUpdateFields(expectedResp map[string]interface{}) utils.CkReqFunc { return func(t *testing.T, _ toclientlib.ReqInf, resp interface{}, _ tc.Alerts, _ error) { assert.RequireNotNil(t, resp, "Expected Server Capabilities response to not be nil.") - serverCapabilitiesResp := resp.(tc.ServerCapability) + serverCapabilitiesResp := resp.(tc.ServerCapabilityV41) for field, expected := range expectedResp { switch field { case "Name": @@ -172,7 +190,7 @@ func validateServerCapabilitiesSort() utils.CkReqFunc { return func(t *testing.T, _ toclientlib.ReqInf, resp interface{}, alerts tc.Alerts, _ error) { assert.RequireNotNil(t, resp, "Expected Server Capabilities response to not be nil.") var serverCapabilityNames []string - serverCapabilitiesResp := resp.([]tc.ServerCapability) + serverCapabilitiesResp := resp.([]tc.ServerCapabilityV41) for _, serverCapability := range serverCapabilitiesResp { serverCapabilityNames = append(serverCapabilityNames, serverCapability.Name) } diff --git a/traffic_ops/testing/api/v5/traffic_control_test.go b/traffic_ops/testing/api/v5/traffic_control_test.go index acabaac327..bb747942e6 100644 --- a/traffic_ops/testing/api/v5/traffic_control_test.go +++ b/traffic_ops/testing/api/v5/traffic_control_test.go @@ -47,7 +47,7 @@ type TrafficControl struct { Roles []tc.RoleV4 `json:"roles"` Servers []tc.ServerV4 `json:"servers"` ServerServerCapabilities []tc.ServerServerCapability `json:"serverServerCapabilities"` - ServerCapabilities []tc.ServerCapability `json:"serverCapabilities"` + ServerCapabilities []tc.ServerCapabilityV41 `json:"serverCapabilities"` ServiceCategories []tc.ServiceCategory `json:"serviceCategories"` Statuses []tc.StatusNullable `json:"statuses"` StaticDNSEntries []tc.StaticDNSEntry `json:"staticdnsentries"` diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index 888054f98a..87c7d687f6 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -66,6 +66,17 @@ FROM ` } +func SelectQueryV41() string { + return ` +SELECT + name, + description, + last_updated +FROM + server_capability sc +` +} + func (v *TOServerCapability) updateQuery() string { return ` UPDATE server_capability sc SET @@ -173,8 +184,7 @@ func GetServerCapability(w http.ResponseWriter, r *http.Request) { return } - selectQuery := "SELECT name, description, last_updated FROM server_capability sc" - query := selectQuery + where + orderBy + pagination + query := SelectQueryV41() + where + orderBy + pagination rows, err := tx.NamedQuery(query, queryValues) if err != nil { api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("server capability read: error getting server capability(ies): %v", err.Error())) @@ -202,9 +212,16 @@ func UpdateServerCapability(w http.ResponseWriter, r *http.Request) { defer inf.Close() tx := inf.Tx.Tx - sc, err := readAndValidateJsonStruct(r, inf) - if err != nil { - api.HandleErr(w, r, tx, http.StatusBadRequest, err, nil) + sc, readValErr := readAndValidateJsonStruct(r) + if readValErr != nil { + api.HandleErr(w, r, tx, http.StatusBadRequest, readValErr, nil) + return + } + + // check if the entity was already updated + userErr, sysErr, errCode = api.CheckIfUnModifiedByName(r.Header, inf.Tx, sc.Name, "server_capability") + if userErr != nil || sysErr != nil { + api.HandleErr(w, r, tx, errCode, userErr, sysErr) return } @@ -216,13 +233,13 @@ func UpdateServerCapability(w http.ResponseWriter, r *http.Request) { WHERE sc.name = $3 RETURNING sc.name, sc.description, sc.last_updated` - err = tx.QueryRow(query, sc.Name, sc.Description, requestedName).Scan(&sc.Name, &sc.Description, &sc.LastUpdated) - if err != nil && err != sql.ErrNoRows { - api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) + err := tx.QueryRow(query, sc.Name, sc.Description, requestedName).Scan(&sc.Name, &sc.Description, &sc.LastUpdated) + if err != nil && err == sql.ErrNoRows { + api.HandleErr(w, r, tx, http.StatusBadRequest, err, nil) return } alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was updated") - api.WriteAlertsObj(w, r, http.StatusCreated, alerts, sc) + api.WriteAlertsObj(w, r, http.StatusOK, alerts, sc) return } @@ -235,26 +252,37 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { defer inf.Close() tx := inf.Tx.Tx - sc, err := readAndValidateJsonStruct(r, inf) + sc, readValErr := readAndValidateJsonStruct(r) + if readValErr != nil { + api.HandleErr(w, r, tx, http.StatusBadRequest, readValErr, nil) + return + } + + // check if capability already exists + var count int + err := tx.QueryRow("SELECT count(*) from server_capability where name = $1", sc.Name).Scan(&count) if err != nil { - api.HandleErr(w, r, tx, http.StatusBadRequest, err, nil) + api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, fmt.Errorf("checking if server capability with name %s exists", sc.Name)) + return + } + if count == 1 { + api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("capability with name: %s already exists", sc.Name), nil) return } // create server capability query := `INSERT INTO server_capability (name, description) VALUES ($1, $2) RETURNING last_updated` err = tx.QueryRow(query, sc.Name, sc.Description).Scan(&sc.LastUpdated) - if err != nil && err != sql.ErrNoRows { + if err != nil && err == sql.ErrNoRows { api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) return } - alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was created") - api.WriteAlertsObj(w, r, http.StatusCreated, alerts, sc) + api.WriteAlertsObj(w, r, http.StatusOK, alerts, sc) return } -func readAndValidateJsonStruct(r *http.Request, inf *api.APIInfo) (tc.ServerCapabilityV41, error) { +func readAndValidateJsonStruct(r *http.Request) (tc.ServerCapabilityV41, error) { var sc tc.ServerCapabilityV41 if err := json.NewDecoder(r.Body).Decode(&sc); err != nil { userErr := fmt.Errorf("error decoding POST request body into ServerCapabilityV41 struct %w", err) @@ -262,8 +290,9 @@ func readAndValidateJsonStruct(r *http.Request, inf *api.APIInfo) (tc.ServerCapa } // validate JSON body + rule := validation.NewStringRule(tovalidate.IsAlphanumericUnderscoreDash, "must consist of only alphanumeric, dash, or underscore characters") errs := tovalidate.ToErrors(validation.Errors{ - "name": validation.Validate(sc.Name, validation.Required), + "name": validation.Validate(sc.Name, validation.Required, rule), }) if len(errs) > 0 { userErr := util.JoinErrs(errs) diff --git a/traffic_ops/v4-client/servercapability.go b/traffic_ops/v4-client/servercapability.go index 511b42e52c..9e9d8567c3 100644 --- a/traffic_ops/v4-client/servercapability.go +++ b/traffic_ops/v4-client/servercapability.go @@ -27,26 +27,26 @@ import ( const apiServerCapabilities = "/server_capabilities" // CreateServerCapability creates the given Server Capability. -func (to *Session) CreateServerCapability(sc tc.ServerCapability, opts RequestOptions) (tc.ServerCapabilityDetailResponse, toclientlib.ReqInf, error) { - var scResp tc.ServerCapabilityDetailResponse +func (to *Session) CreateServerCapability(sc tc.ServerCapabilityV41, opts RequestOptions) (tc.ServerCapabilityDetailResponseV41, toclientlib.ReqInf, error) { + var scResp tc.ServerCapabilityDetailResponseV41 reqInf, err := to.post(apiServerCapabilities, opts, sc, &scResp) return scResp, reqInf, err } // GetServerCapabilities returns all the Server Capabilities in Traffic Ops. -func (to *Session) GetServerCapabilities(opts RequestOptions) (tc.ServerCapabilitiesResponse, toclientlib.ReqInf, error) { - var data tc.ServerCapabilitiesResponse +func (to *Session) GetServerCapabilities(opts RequestOptions) (tc.ServerCapabilitiesResponseV41, toclientlib.ReqInf, error) { + var data tc.ServerCapabilitiesResponseV41 reqInf, err := to.get(apiServerCapabilities, opts, &data) return data, reqInf, err } // UpdateServerCapability updates a Server Capability by name. -func (to *Session) UpdateServerCapability(name string, sc tc.ServerCapability, opts RequestOptions) (tc.ServerCapabilityDetailResponse, toclientlib.ReqInf, error) { +func (to *Session) UpdateServerCapability(name string, sc tc.ServerCapabilityV41, opts RequestOptions) (tc.ServerCapabilityDetailResponseV41, toclientlib.ReqInf, error) { if opts.QueryParameters == nil { opts.QueryParameters = url.Values{} } opts.QueryParameters.Set("name", name) - var data tc.ServerCapabilityDetailResponse + var data tc.ServerCapabilityDetailResponseV41 reqInf, err := to.put(apiServerCapabilities, opts, sc, &data) return data, reqInf, err } diff --git a/traffic_ops/v5-client/servercapability.go b/traffic_ops/v5-client/servercapability.go index 511b42e52c..9e9d8567c3 100644 --- a/traffic_ops/v5-client/servercapability.go +++ b/traffic_ops/v5-client/servercapability.go @@ -27,26 +27,26 @@ import ( const apiServerCapabilities = "/server_capabilities" // CreateServerCapability creates the given Server Capability. -func (to *Session) CreateServerCapability(sc tc.ServerCapability, opts RequestOptions) (tc.ServerCapabilityDetailResponse, toclientlib.ReqInf, error) { - var scResp tc.ServerCapabilityDetailResponse +func (to *Session) CreateServerCapability(sc tc.ServerCapabilityV41, opts RequestOptions) (tc.ServerCapabilityDetailResponseV41, toclientlib.ReqInf, error) { + var scResp tc.ServerCapabilityDetailResponseV41 reqInf, err := to.post(apiServerCapabilities, opts, sc, &scResp) return scResp, reqInf, err } // GetServerCapabilities returns all the Server Capabilities in Traffic Ops. -func (to *Session) GetServerCapabilities(opts RequestOptions) (tc.ServerCapabilitiesResponse, toclientlib.ReqInf, error) { - var data tc.ServerCapabilitiesResponse +func (to *Session) GetServerCapabilities(opts RequestOptions) (tc.ServerCapabilitiesResponseV41, toclientlib.ReqInf, error) { + var data tc.ServerCapabilitiesResponseV41 reqInf, err := to.get(apiServerCapabilities, opts, &data) return data, reqInf, err } // UpdateServerCapability updates a Server Capability by name. -func (to *Session) UpdateServerCapability(name string, sc tc.ServerCapability, opts RequestOptions) (tc.ServerCapabilityDetailResponse, toclientlib.ReqInf, error) { +func (to *Session) UpdateServerCapability(name string, sc tc.ServerCapabilityV41, opts RequestOptions) (tc.ServerCapabilityDetailResponseV41, toclientlib.ReqInf, error) { if opts.QueryParameters == nil { opts.QueryParameters = url.Values{} } opts.QueryParameters.Set("name", name) - var data tc.ServerCapabilityDetailResponse + var data tc.ServerCapabilityDetailResponseV41 reqInf, err := to.put(apiServerCapabilities, opts, sc, &data) return data, reqInf, err } From a48b18d4a8bdd01cd19935d3ec22a2dabb65e7e9 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Wed, 7 Dec 2022 20:32:55 -0700 Subject: [PATCH 09/21] Fixed go vet and CIAB and TP --- .../cdn-in-a-box/enroller/enroller.go | 2 +- .../servercapability/servercapability.go | 16 +--- .../integration/Data/servercapabilities.ts | 90 +++++++++---------- .../PageObjects/ServerCapabilitiesPage.po.ts | 4 +- .../specs/ServerCapabilities.spec.ts | 10 +-- 5 files changed, 56 insertions(+), 66 deletions(-) diff --git a/infrastructure/cdn-in-a-box/enroller/enroller.go b/infrastructure/cdn-in-a-box/enroller/enroller.go index 0633ab51bb..83979b5bbc 100644 --- a/infrastructure/cdn-in-a-box/enroller/enroller.go +++ b/infrastructure/cdn-in-a-box/enroller/enroller.go @@ -774,7 +774,7 @@ func enrollServer(toSession *session, r io.Reader) error { // enrollServerCapability takes a json file and creates a ServerCapability object using the TO API func enrollServerCapability(toSession *session, r io.Reader) error { dec := json.NewDecoder(r) - var s tc.ServerCapability + var s tc.ServerCapabilityV41 err := dec.Decode(&s) if err != nil { err = fmt.Errorf("error decoding Server Capability: %v", err) diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index 87c7d687f6..db92fd267f 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -66,17 +66,6 @@ FROM ` } -func SelectQueryV41() string { - return ` -SELECT - name, - description, - last_updated -FROM - server_capability sc -` -} - func (v *TOServerCapability) updateQuery() string { return ` UPDATE server_capability sc SET @@ -184,8 +173,9 @@ func GetServerCapability(w http.ResponseWriter, r *http.Request) { return } - query := SelectQueryV41() + where + orderBy + pagination - rows, err := tx.NamedQuery(query, queryValues) + selectQuery := "SELECT name, description, last_updated FROM server_capability sc" + query := selectQuery + where + orderBy + pagination + rows, err := tx.Query(query, queryValues) if err != nil { api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("server capability read: error getting server capability(ies): %v", err.Error())) } diff --git a/traffic_portal/test/integration/Data/servercapabilities.ts b/traffic_portal/test/integration/Data/servercapabilities.ts index 1a8ece5770..81fb39f625 100644 --- a/traffic_portal/test/integration/Data/servercapabilities.ts +++ b/traffic_portal/test/integration/Data/servercapabilities.ts @@ -19,9 +19,9 @@ interface Removal { - caseDescription: string; - name: string; description: string; + name: string; + capabilityDescription: string; validationMessage: string; } @@ -48,75 +48,75 @@ export const serverCapabilities = { ], check: [ { - caseDescription: "check CSV link from Server Capabilities page", + description: "check CSV link from Server Capabilities page", Name: "Export as CSV" } ], add: [ { - caseDescription: "can create a server capability", + description: "can create a server capability", name: "TP_SC", - description: "Server Capability", + capabilityDescription: "Server Capability", validationMessage: "server capability was created." }, { - caseDescription: "can create multiple server capabilities", + description: "can create multiple server capabilities", name: "TP_SC_2", - description: "Server Capability 2", + capabilityDescription: "Server Capability 2", validationMessage: "server capability was created." }, { - caseDescription: "can create multiple server capabilities", + description: "can create multiple server capabilities", name: "TP_SC_3", - description: "Server Capability 3", + capabilityDescription: "Server Capability 3", validationMessage: "server capability was created." }, { - caseDescription: "can handle creating existing server capability", + description: "can handle creating existing server capability", name: "TP_SC_2", - description: "Server Capability 2", + capabilityDescription: "Server Capability 2", validationMessage: "server_capability name 'TP_SC_2' already exists." }, { - caseDescription: "can handle invalid period in server capability", + description: "can handle invalid period in server capability", name: "TP.AUTOMATED", - description: "Server Capability Automated", + capabilityDescription: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - caseDescription: "can handle invalid space in server capability", + description: "can handle invalid space in server capability", name: "TP AUTOMATED", - description: "Server Capability Automated", + capabilityDescription: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - caseDescription: "can handle invalid character in server capability", + description: "can handle invalid character in server capability", name: "TP#AUTOMATED", - description: "Server Capability Automated", + capabilityDescription: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - caseDescription: "can handle an empty text field", + description: "can handle an empty text field", name: "", - description: "", + capabilityDescription: "", validationMessage: "Required" } ], remove: [ { - caseDescription: "can delete a server capability", + description: "can delete a server capability", invalid: false, name: "TP_SC", validationMessage: "server capability was deleted." }, { - caseDescription: "can handle an invalid delete entry", + description: "can handle an invalid delete entry", invalid: true, name: "TP_SC_2", invalidName: "TP_AUTOMATED" }, { - caseDescription: "can delete multiple server capabilities", + description: "can delete multiple server capabilities", invalid: false, name: "TP_SC_2", validationMessage: "server capability was deleted." @@ -133,21 +133,21 @@ export const serverCapabilities = { ], check: [ { - caseDescription: "check CSV link from Server Capabilities page", + description: "check CSV link from Server Capabilities page", Name: "Export as CSV" } ], add: [ { - caseDescription: "can handle readonly role creating a server capability", + description: "can handle readonly role creating a server capability", name: "TP_SC", - description: "Server Capability", + capabilityDescription: "Server Capability", validationMessage: "missing required Permissions: SERVER-CAPABILITY:CREATE" } ], remove: [ { - caseDescription: "can handle readonly role deleting a server capability", + description: "can handle readonly role deleting a server capability", invalid: false, name: "TP_SC_3", validationMessage: "missing required Permissions: SERVER-CAPABILITY:DELETE" @@ -164,75 +164,75 @@ export const serverCapabilities = { ], check: [ { - caseDescription: "check CSV link from Server Capabilities page", + description: "check CSV link from Server Capabilities page", Name: "Export as CSV" } ], add: [ { - caseDescription: "can create a server capability", + description: "can create a server capability", name: "TP_SC", - description: "Server Capability", + capabilityDescription: "Server Capability", validationMessage: "server capability was created." }, { - caseDescription: "can create multiple server capabilities", + description: "can create multiple server capabilities", name: "TP_SC_2", - description: "Server Capability 2", + capabilityDescription: "Server Capability 2", validationMessage: "server capability was created." }, { - caseDescription: "can handle creating existing server capability", + description: "can handle creating existing server capability", name: "TP_SC_2", - description: "Server Capability 2", + capabilityDescription: "Server Capability 2", validationMessage: "server_capability name 'TP_SC_2' already exists." }, { - caseDescription: "can handle invalid period in server capability", + description: "can handle invalid period in server capability", name: "TP.AUTOMATED", - description: "Server Capability Automated", + capabilityDescription: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - caseDescription: "can handle invalid space in server capability", + description: "can handle invalid space in server capability", name: "TP AUTOMATED", - description: "Server Capability Automated", + capabilityDescription: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - caseDescription: "can handle invalid character in server capability", + description: "can handle invalid character in server capability", name: "TP#AUTOMATED", - description: "Server Capability Automated", + capabilityDescription: "Server Capability Automated", validationMessage: "Must be alphamumeric with no spaces. Dashes and underscores also allowed." }, { - caseDescription: "can handle an empty text field", + description: "can handle an empty text field", name: "", - description: "", + capabilityDescription: "", validationMessage: "Required" } ], remove: [ { - caseDescription: "can delete a server capability", + description: "can delete a server capability", name: "TP_SC", invalid: false, validationMessage: "server capability was deleted." }, { - caseDescription: "can handle an invalid delete entry", + description: "can handle an invalid delete entry", name: "TP_SC_2", invalid: true, invalidName: "TP_AUTOMATED" }, { - caseDescription: "can delete multiple server capabilities", + description: "can delete multiple server capabilities", name: "TP_SC_2", invalid: false, validationMessage: "server capability was deleted." }, { - caseDescription: "can delete multiple server capabilities", + description: "can delete multiple server capabilities", name: "TP_SC_3", invalid: false, validationMessage: "server capability was deleted." diff --git a/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts b/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts index dca90bf798..4fd70f9840 100644 --- a/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts +++ b/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts @@ -47,12 +47,12 @@ export class ServerCapabilitiesPage extends BasePage{ let basePage = new BasePage(); let snp= new SideNavigationPage(); let name = nameSC+this.randomize; - let description = descriptionSC + let capabilityDescription = descriptionSC; await this.btnCreateServerCapabilities.click(); if(name != this.randomize){ await this.txtSCName.sendKeys(name); } - await this.txtSCDescription.sendKeys(description); + await this.txtSCDescription.sendKeys(capabilityDescription); if(outputMessage == await(basePage.GetBlankErrorMessage()) || outputMessage == await(basePage.GetSyntaxErrorMessage())) { await snp.NavigateToServerCapabilitiesPage(); result = true; diff --git a/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts b/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts index e7961bfab3..6bbc4a9789 100644 --- a/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts +++ b/traffic_portal/test/integration/specs/ServerCapabilities.spec.ts @@ -40,26 +40,26 @@ serverCapabilities.tests.forEach(serverCapabilitiesData => { await serverCapabilitiesPage.OpenServerCapabilityPage(); }); serverCapabilitiesData.check.forEach(check => { - it(check.caseDescription, async () => { + it(check.description, async () => { expect(await serverCapabilitiesPage.CheckCSV(check.Name)).toBe(true); await serverCapabilitiesPage.OpenServerCapabilityPage(); }); }); serverCapabilitiesData.add.forEach(add => { - it(add.caseDescription, async () => { - expect(await serverCapabilitiesPage.CreateServerCapabilities(add.name, add.description, add.validationMessage)).toBe(true); + it(add.description, async () => { + expect(await serverCapabilitiesPage.CreateServerCapabilities(add.name, add.capabilityDescription, add.validationMessage)).toBe(true); await serverCapabilitiesPage.OpenServerCapabilityPage(); }); }); serverCapabilitiesData.remove.forEach(remove => { if (remove.invalid) { - it(remove.caseDescription, async () => { + it(remove.description, async () => { await serverCapabilitiesPage.SearchServerCapabilities(remove.name) expect(await serverCapabilitiesPage.DeleteServerCapabilities(remove.invalidName, remove.validationMessage)).toBe(false); await serverCapabilitiesPage.OpenServerCapabilityPage(); }); } else { - it(remove.caseDescription, async () => { + it(remove.description, async () => { await serverCapabilitiesPage.SearchServerCapabilities(remove.name) expect(await serverCapabilitiesPage.DeleteServerCapabilities(remove.name, remove.validationMessage)).toBe(true); await serverCapabilitiesPage.OpenServerCapabilityPage(); From 6e0dd4bd6d8bd7602cffef288dd4dda8f3234544 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Wed, 7 Dec 2022 21:28:28 -0700 Subject: [PATCH 10/21] Added descriptive tests for functions --- lib/go-tc/server_capabilities.go | 2 ++ .../traffic_ops_golang/servercapability/servercapability.go | 6 +++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/go-tc/server_capabilities.go b/lib/go-tc/server_capabilities.go index 9c07d1cc30..fea75df251 100644 --- a/lib/go-tc/server_capabilities.go +++ b/lib/go-tc/server_capabilities.go @@ -25,6 +25,7 @@ type ServerCapabilitiesResponse struct { Alerts } +// ServerCapabilitiesResponseV41 contains the result data from a GET(v4.1 and above) /server_capabilities request. type ServerCapabilitiesResponseV41 struct { Response []ServerCapabilityV41 `json:"response"` Alerts @@ -48,6 +49,7 @@ type ServerCapabilityDetailResponse struct { Alerts } +// ServerCapabilityDetailResponseV41 contains the result data from a POST(v4.1 and above) /server_capabilities request. type ServerCapabilityDetailResponseV41 struct { Response ServerCapabilityV41 `json:"response"` Alerts diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index db92fd267f..186456535a 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -175,16 +175,16 @@ func GetServerCapability(w http.ResponseWriter, r *http.Request) { selectQuery := "SELECT name, description, last_updated FROM server_capability sc" query := selectQuery + where + orderBy + pagination - rows, err := tx.Query(query, queryValues) + rows, err := tx.NamedQuery(query, queryValues) if err != nil { - api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("server capability read: error getting server capability(ies): %v", err.Error())) + api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("server capability read: error getting server capability(ies): %w", err)) } defer log.Close(rows, "unable to close DB connection") var scList []tc.ServerCapabilityV41 for rows.Next() { if err = rows.Scan(&sc.Name, &sc.Description, &sc.LastUpdated); err != nil { - api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("error getting server capability(ies): "+err.Error())) + api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("error getting server capability(ies): %w", err)) } scList = append(scList, sc) } From 186440073c2204fe4059b4538cc81ab181df0ccc Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Thu, 8 Dec 2022 11:27:24 -0700 Subject: [PATCH 11/21] Fixed Tests(v4/v5) --- .../servercapability/servercapability.go | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index 186456535a..88a35a9dc6 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -165,7 +165,10 @@ func GetServerCapability(w http.ResponseWriter, r *http.Request) { // Query Parameters to Database Query column mappings queryParamsToQueryCols := map[string]dbhelpers.WhereColumnInfo{ - "name": dbhelpers.WhereColumnInfo{Column: "sc.name"}, + "name": {Column: "sc.name", Checker: nil}, + } + if _, ok := inf.Params["orderby"]; !ok { + inf.Params["orderby"] = "name" } where, orderBy, pagination, queryValues, errs := dbhelpers.BuildWhereAndOrderByAndPagination(inf.Params, queryParamsToQueryCols) if len(errs) > 0 { @@ -208,15 +211,15 @@ func UpdateServerCapability(w http.ResponseWriter, r *http.Request) { return } + requestedName := inf.Params["name"] // check if the entity was already updated - userErr, sysErr, errCode = api.CheckIfUnModifiedByName(r.Header, inf.Tx, sc.Name, "server_capability") + userErr, sysErr, errCode = api.CheckIfUnModifiedByName(r.Header, inf.Tx, requestedName, "server_capability") if userErr != nil || sysErr != nil { api.HandleErr(w, r, tx, errCode, userErr, sysErr) return } //update name and description of a capability - requestedName := inf.Params["name"] query := `UPDATE server_capability sc SET name = $1, description = $2 From 0b66f830f1fb61cf780dec8d4aa8649db563523e Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Fri, 9 Dec 2022 12:11:08 -0700 Subject: [PATCH 12/21] Response is not null --- lib/go-tc/server_capabilities.go | 3 +++ .../traffic_ops_golang/servercapability/servercapability.go | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/lib/go-tc/server_capabilities.go b/lib/go-tc/server_capabilities.go index fea75df251..328cb6933f 100644 --- a/lib/go-tc/server_capabilities.go +++ b/lib/go-tc/server_capabilities.go @@ -37,6 +37,9 @@ type ServerCapability struct { LastUpdated *TimeNoMod `json:"lastUpdated" db:"last_updated"` } +// ServerCapabilityV4 is an alias for the latest minor version for the major version 4. +type ServerCapabilityV4 ServerCapabilityV41 + // ServerCapabilityV41 contains information (in-addition to description) about a given ServerCapability in Traffic Ops. type ServerCapabilityV41 struct { ServerCapability diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index 88a35a9dc6..a166007fd2 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -154,7 +154,7 @@ func (v *TOServerCapability) Update(h http.Header) (error, error, int) { } func GetServerCapability(w http.ResponseWriter, r *http.Request) { - var sc tc.ServerCapabilityV41 + var sc tc.ServerCapabilityV4 inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil) tx := inf.Tx if userErr != nil || sysErr != nil { @@ -184,7 +184,7 @@ func GetServerCapability(w http.ResponseWriter, r *http.Request) { } defer log.Close(rows, "unable to close DB connection") - var scList []tc.ServerCapabilityV41 + scList := []tc.ServerCapabilityV4{} for rows.Next() { if err = rows.Scan(&sc.Name, &sc.Description, &sc.LastUpdated); err != nil { api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("error getting server capability(ies): %w", err)) From 140c0c38d6d5e79205788858f7a2f4f9062891fa Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Mon, 12 Dec 2022 13:39:43 -0700 Subject: [PATCH 13/21] Not break v4 client methods --- .../api/v4/server_capabilities_test.go | 8 ++--- traffic_ops/v4-client/servercapability.go | 34 +++++++++++++++++-- 2 files changed, 35 insertions(+), 7 deletions(-) diff --git a/traffic_ops/testing/api/v4/server_capabilities_test.go b/traffic_ops/testing/api/v4/server_capabilities_test.go index c19fa171ba..e3c60fcd86 100644 --- a/traffic_ops/testing/api/v4/server_capabilities_test.go +++ b/traffic_ops/testing/api/v4/server_capabilities_test.go @@ -137,21 +137,21 @@ func TestServerCapabilities(t *testing.T) { switch method { case "GET": t.Run(name, func(t *testing.T) { - resp, reqInf, err := testCase.ClientSession.GetServerCapabilities(testCase.RequestOpts) + resp, reqInf, err := testCase.ClientSession.GetServerCapabilitiesV41(testCase.RequestOpts) for _, check := range testCase.Expectations { check(t, reqInf, resp.Response, resp.Alerts, err) } }) case "POST": t.Run(name, func(t *testing.T) { - resp, reqInf, err := testCase.ClientSession.CreateServerCapability(testCase.RequestBody, testCase.RequestOpts) + resp, reqInf, err := testCase.ClientSession.CreateServerCapabilityV41(testCase.RequestBody, testCase.RequestOpts) for _, check := range testCase.Expectations { check(t, reqInf, resp.Response, resp.Alerts, err) } }) case "PUT": t.Run(name, func(t *testing.T) { - resp, reqInf, err := testCase.ClientSession.UpdateServerCapability(testCase.RequestOpts.QueryParameters["name"][0], testCase.RequestBody, testCase.RequestOpts) + resp, reqInf, err := testCase.ClientSession.UpdateServerCapabilityV41(testCase.RequestOpts.QueryParameters["name"][0], testCase.RequestBody, testCase.RequestOpts) for _, check := range testCase.Expectations { check(t, reqInf, resp.Response, resp.Alerts, err) } @@ -199,7 +199,7 @@ func validateServerCapabilitiesSort() utils.CkReqFunc { func CreateTestServerCapabilities(t *testing.T) { for _, sc := range testData.ServerCapabilities { - resp, _, err := TOSession.CreateServerCapability(sc, client.RequestOptions{}) + resp, _, err := TOSession.CreateServerCapabilityV41(sc, client.RequestOptions{}) assert.RequireNoError(t, err, "Unexpected error creating Server Capability '%s': %v - alerts: %+v", sc.Name, err, resp.Alerts) } } diff --git a/traffic_ops/v4-client/servercapability.go b/traffic_ops/v4-client/servercapability.go index 9e9d8567c3..1b41e18827 100644 --- a/traffic_ops/v4-client/servercapability.go +++ b/traffic_ops/v4-client/servercapability.go @@ -27,21 +27,49 @@ import ( const apiServerCapabilities = "/server_capabilities" // CreateServerCapability creates the given Server Capability. -func (to *Session) CreateServerCapability(sc tc.ServerCapabilityV41, opts RequestOptions) (tc.ServerCapabilityDetailResponseV41, toclientlib.ReqInf, error) { +// Note: Call Signature changed in v5, accepts tc.ServerCapabilityV41 instead of tc.ServerCapability +func (to *Session) CreateServerCapability(sc tc.ServerCapability, opts RequestOptions) (tc.ServerCapabilityDetailResponse, toclientlib.ReqInf, error) { + var scResp tc.ServerCapabilityDetailResponse + reqInf, err := to.post(apiServerCapabilities, opts, sc, &scResp) + return scResp, reqInf, err +} + +// CreateServerCapabilityV41 creates the given Server Capability V41 (includes description). +func (to *Session) CreateServerCapabilityV41(sc tc.ServerCapabilityV41, opts RequestOptions) (tc.ServerCapabilityDetailResponseV41, toclientlib.ReqInf, error) { var scResp tc.ServerCapabilityDetailResponseV41 reqInf, err := to.post(apiServerCapabilities, opts, sc, &scResp) return scResp, reqInf, err } // GetServerCapabilities returns all the Server Capabilities in Traffic Ops. -func (to *Session) GetServerCapabilities(opts RequestOptions) (tc.ServerCapabilitiesResponseV41, toclientlib.ReqInf, error) { +// Note: Call Signature changed in v5, accepts tc.ServerCapabilitiesResponseV41 instead of tc.ServerCapabilitiesResponse +func (to *Session) GetServerCapabilities(opts RequestOptions) (tc.ServerCapabilitiesResponse, toclientlib.ReqInf, error) { + var data tc.ServerCapabilitiesResponse + reqInf, err := to.get(apiServerCapabilities, opts, &data) + return data, reqInf, err +} + +// GetServerCapabilitiesV41 returns all the Server Capabilities V41 (includes description) in Traffic Ops. +func (to *Session) GetServerCapabilitiesV41(opts RequestOptions) (tc.ServerCapabilitiesResponseV41, toclientlib.ReqInf, error) { var data tc.ServerCapabilitiesResponseV41 reqInf, err := to.get(apiServerCapabilities, opts, &data) return data, reqInf, err } // UpdateServerCapability updates a Server Capability by name. -func (to *Session) UpdateServerCapability(name string, sc tc.ServerCapabilityV41, opts RequestOptions) (tc.ServerCapabilityDetailResponseV41, toclientlib.ReqInf, error) { +// Note: Call Signature changed in v5, accepts tc.ServerCapabilityV41 instead of tc.ServerCapability +func (to *Session) UpdateServerCapability(name string, sc tc.ServerCapability, opts RequestOptions) (tc.ServerCapabilityDetailResponse, toclientlib.ReqInf, error) { + if opts.QueryParameters == nil { + opts.QueryParameters = url.Values{} + } + opts.QueryParameters.Set("name", name) + var data tc.ServerCapabilityDetailResponse + reqInf, err := to.put(apiServerCapabilities, opts, sc, &data) + return data, reqInf, err +} + +// UpdateServerCapabilityV41 updates a Server Capability V41 (includes description) by name. +func (to *Session) UpdateServerCapabilityV41(name string, sc tc.ServerCapabilityV41, opts RequestOptions) (tc.ServerCapabilityDetailResponseV41, toclientlib.ReqInf, error) { if opts.QueryParameters == nil { opts.QueryParameters = url.Values{} } From 5466df4b6a4ec4ef09adc5db251529119746db78 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Tue, 13 Dec 2022 12:38:53 -0700 Subject: [PATCH 14/21] Added DeleteServerCapability() for 5 --- .../cdn-in-a-box/enroller/enroller.go | 4 +- .../dbhelpers/db_helpers.go | 15 +++++ .../traffic_ops_golang/routing/routes.go | 2 +- .../servercapability/servercapability.go | 56 +++++++++++++++++++ 4 files changed, 74 insertions(+), 3 deletions(-) diff --git a/infrastructure/cdn-in-a-box/enroller/enroller.go b/infrastructure/cdn-in-a-box/enroller/enroller.go index 83979b5bbc..c3a031afed 100644 --- a/infrastructure/cdn-in-a-box/enroller/enroller.go +++ b/infrastructure/cdn-in-a-box/enroller/enroller.go @@ -771,7 +771,7 @@ func enrollServer(toSession *session, r io.Reader) error { return err } -// enrollServerCapability takes a json file and creates a ServerCapability object using the TO API +// enrollServerCapability takes a json file and creates a ServerCapabilityV41 object using the TO API func enrollServerCapability(toSession *session, r io.Reader) error { dec := json.NewDecoder(r) var s tc.ServerCapabilityV41 @@ -782,7 +782,7 @@ func enrollServerCapability(toSession *session, r io.Reader) error { return err } - alerts, _, err := toSession.CreateServerCapability(s, client.RequestOptions{}) + alerts, _, err := toSession.CreateServerCapabilityV41(s, client.RequestOptions{}) if err != nil { err = fmt.Errorf("error creating Server Capability: %v - alerts: %+v", err, alerts.Alerts) log.Infoln(err) diff --git a/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go b/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go index 7b1dae9fd0..b96416bb18 100644 --- a/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go +++ b/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go @@ -2184,3 +2184,18 @@ func GetProfileIDDesc(tx *sql.Tx, name string) (id int, desc string) { } return } + +// GetSCInfo confirms whether the server capability exists, and an error (if one occurs). +func GetSCInfo(tx *sqlx.Tx, name string) (bool, error) { + var count int + if err := tx.QueryRow("SELECT count(name) FROM server_capability AS sc WHERE sc.name=$1", name).Scan(&count); err != nil { + return false, fmt.Errorf("getting server capability info: %v", err) + } + if count == 0 { + return false, nil + } + if count != 1 { + return false, fmt.Errorf("getting server capability info - expected row count: 1, actual: %d", count) + } + return true, nil +} diff --git a/traffic_ops/traffic_ops_golang/routing/routes.go b/traffic_ops/traffic_ops_golang/routing/routes.go index 016521d6b0..2a3df2e1ba 100644 --- a/traffic_ops/traffic_ops_golang/routing/routes.go +++ b/traffic_ops/traffic_ops_golang/routing/routes.go @@ -327,7 +327,7 @@ func Routes(d ServerData) ([]Route, http.Handler, error) { {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodGet, Path: `server_capabilities$`, Handler: servercapability.GetServerCapability, RequiredPrivLevel: auth.PrivLevelReadOnly, RequiredPermissions: []string{"SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 41040739131}, {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodPost, Path: `server_capabilities$`, Handler: servercapability.CreateServerCapability, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:CREATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 407447070831}, {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodPut, Path: `server_capabilities$`, Handler: servercapability.UpdateServerCapability, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:UPDATE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 425437701091}, - {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodDelete, Path: `server_capabilities$`, Handler: api.DeleteHandler(&servercapability.TOServerCapability{}), RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:DELETE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 43641503831}, + {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodDelete, Path: `server_capabilities$`, Handler: servercapability.DeleteServerCapability, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER-CAPABILITY:DELETE", "SERVER-CAPABILITY:READ"}, Authenticated: Authenticated, Middlewares: nil, ID: 43641503831}, {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodPost, Path: `multiple_servers_capabilities/?$`, Handler: server.AssignMultipleServersCapabilities, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER:READ", "SERVER:CREATE", "SERVER-CAPABILITY:READ", "SERVER-CAPABILITY:CREATE"}, Authenticated: Authenticated, Middlewares: nil, ID: 407924192581}, {Version: api.Version{Major: 5, Minor: 0}, Method: http.MethodDelete, Path: `multiple_servers_capabilities/?$`, Handler: server.DeleteMultipleServersCapabilities, RequiredPrivLevel: auth.PrivLevelOperations, RequiredPermissions: []string{"SERVER:READ", "SERVER:DELETE", "SERVER-CAPABILITY:READ", "SERVER-CAPABILITY:DELETE"}, Authenticated: Authenticated, Middlewares: nil, ID: 407924192781}, diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index a166007fd2..1dbd20bd9b 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -181,6 +181,7 @@ func GetServerCapability(w http.ResponseWriter, r *http.Request) { rows, err := tx.NamedQuery(query, queryValues) if err != nil { api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("server capability read: error getting server capability(ies): %w", err)) + return } defer log.Close(rows, "unable to close DB connection") @@ -188,6 +189,7 @@ func GetServerCapability(w http.ResponseWriter, r *http.Request) { for rows.Next() { if err = rows.Scan(&sc.Name, &sc.Description, &sc.LastUpdated); err != nil { api.HandleErr(w, r, tx.Tx, http.StatusInternalServerError, nil, fmt.Errorf("error getting server capability(ies): %w", err)) + return } scList = append(scList, sc) } @@ -275,6 +277,60 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { return } +func DeleteServerCapability(w http.ResponseWriter, r *http.Request) { + inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil) + tx := inf.Tx.Tx + if userErr != nil || sysErr != nil { + api.HandleErr(w, r, tx, errCode, userErr, sysErr) + return + } + defer inf.Close() + + name := inf.Params["name"] + exists, err := dbhelpers.GetSCInfo(inf.Tx, name) + fmt.Println(exists, name) + if err != nil { + api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) + return + } + if !exists { + if name != "" { + api.HandleErr(w, r, tx, http.StatusNotFound, fmt.Errorf("no server capability exists by name: %s", name), nil) + return + } else { + api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("no server capability exists for empty name: %s", name), nil) + return + } + } + + assignedServer := 0 + if err := inf.Tx.Get(&assignedServer, "SELECT count(server) FROM server_server_capability ssc WHERE ssc.server_capability=$1", name); err != nil { + api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, fmt.Errorf("server capability delete, counting assigned servers: %w", err)) + return + } else if assignedServer != 0 { + api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("can not delete a server capability with %d assigned servers", assignedServer), nil) + return + } + + res, err := tx.Exec("DELETE FROM server_capability AS sc WHERE sc.name=$1", name) + if err != nil { + api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) + return + } + rowsAffected, err := res.RowsAffected() + if err != nil { + api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, fmt.Errorf("determining rows affected for delete server capability: %w", err)) + return + } + if rowsAffected == 0 { + api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("no rows deleted for server capability"), nil) + return + } + + api.WriteResp(w, r, "Successfully deleted server capability "+name) + return +} + func readAndValidateJsonStruct(r *http.Request) (tc.ServerCapabilityV41, error) { var sc tc.ServerCapabilityV41 if err := json.NewDecoder(r.Body).Decode(&sc); err != nil { From 51b4b5c670d37d25bbccd1fa6333f6b023fba9b5 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Tue, 13 Dec 2022 20:39:41 -0700 Subject: [PATCH 15/21] TP fixes --- .../traffic_ops_golang/servercapability/servercapability.go | 5 ++--- traffic_portal/test/integration/Data/servercapabilities.ts | 1 - .../integration/PageObjects/ServerCapabilitiesPage.po.ts | 3 +-- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index 1dbd20bd9b..b37ccda739 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -261,7 +261,7 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { return } if count == 1 { - api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("capability with name: %s already exists", sc.Name), nil) + api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("server_capability name '%s' already exists.", sc.Name), nil) return } @@ -272,7 +272,7 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) return } - alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was created") + alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was created.") api.WriteAlertsObj(w, r, http.StatusOK, alerts, sc) return } @@ -288,7 +288,6 @@ func DeleteServerCapability(w http.ResponseWriter, r *http.Request) { name := inf.Params["name"] exists, err := dbhelpers.GetSCInfo(inf.Tx, name) - fmt.Println(exists, name) if err != nil { api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) return diff --git a/traffic_portal/test/integration/Data/servercapabilities.ts b/traffic_portal/test/integration/Data/servercapabilities.ts index 81fb39f625..148cf4427e 100644 --- a/traffic_portal/test/integration/Data/servercapabilities.ts +++ b/traffic_portal/test/integration/Data/servercapabilities.ts @@ -21,7 +21,6 @@ interface Removal { description: string; name: string; - capabilityDescription: string; validationMessage: string; } diff --git a/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts b/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts index 4fd70f9840..1eb7bbc5bb 100644 --- a/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts +++ b/traffic_portal/test/integration/PageObjects/ServerCapabilitiesPage.po.ts @@ -47,12 +47,11 @@ export class ServerCapabilitiesPage extends BasePage{ let basePage = new BasePage(); let snp= new SideNavigationPage(); let name = nameSC+this.randomize; - let capabilityDescription = descriptionSC; await this.btnCreateServerCapabilities.click(); if(name != this.randomize){ await this.txtSCName.sendKeys(name); } - await this.txtSCDescription.sendKeys(capabilityDescription); + await this.txtSCDescription.sendKeys(descriptionSC); if(outputMessage == await(basePage.GetBlankErrorMessage()) || outputMessage == await(basePage.GetSyntaxErrorMessage())) { await snp.NavigateToServerCapabilitiesPage(); result = true; From 50ac4a7e59d8e48438a44eb6b93e9a5a9966f0be Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Thu, 15 Dec 2022 12:38:00 -0700 Subject: [PATCH 16/21] Addressed review comments --- .../dbhelpers/db_helpers.go | 2 +- .../servercapability/servercapability.go | 19 ++++++++++--------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go b/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go index b96416bb18..ffee106443 100644 --- a/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go +++ b/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go @@ -2189,7 +2189,7 @@ func GetProfileIDDesc(tx *sql.Tx, name string) (id int, desc string) { func GetSCInfo(tx *sqlx.Tx, name string) (bool, error) { var count int if err := tx.QueryRow("SELECT count(name) FROM server_capability AS sc WHERE sc.name=$1", name).Scan(&count); err != nil { - return false, fmt.Errorf("getting server capability info: %v", err) + return false, fmt.Errorf("getting server capability info: %w", err) } if count == 0 { return false, nil diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index b37ccda739..381216cf4d 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -20,7 +20,6 @@ package servercapability */ import ( - "database/sql" "encoding/json" "fmt" "net/http" @@ -229,8 +228,9 @@ func UpdateServerCapability(w http.ResponseWriter, r *http.Request) { RETURNING sc.name, sc.description, sc.last_updated` err := tx.QueryRow(query, sc.Name, sc.Description, requestedName).Scan(&sc.Name, &sc.Description, &sc.LastUpdated) - if err != nil && err == sql.ErrNoRows { - api.HandleErr(w, r, tx, http.StatusBadRequest, err, nil) + if err != nil { + usrErr, sysErr, code := api.ParseDBError(err) + api.HandleErr(w, r, tx, code, usrErr, sysErr) return } alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was updated") @@ -257,7 +257,7 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { var count int err := tx.QueryRow("SELECT count(*) from server_capability where name = $1", sc.Name).Scan(&count) if err != nil { - api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, fmt.Errorf("checking if server capability with name %s exists", sc.Name)) + api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, fmt.Errorf("error: %w, when checking if server capability with name %s exists", err, sc.Name)) return } if count == 1 { @@ -268,12 +268,13 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { // create server capability query := `INSERT INTO server_capability (name, description) VALUES ($1, $2) RETURNING last_updated` err = tx.QueryRow(query, sc.Name, sc.Description).Scan(&sc.LastUpdated) - if err != nil && err == sql.ErrNoRows { - api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) + if err != nil { + usrErr, sysErr, code := api.ParseDBError(err) + api.HandleErr(w, r, tx, code, usrErr, sysErr) return } alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was created.") - api.WriteAlertsObj(w, r, http.StatusOK, alerts, sc) + api.WriteAlertsObj(w, r, http.StatusCreated, alerts, sc) return } @@ -325,8 +326,8 @@ func DeleteServerCapability(w http.ResponseWriter, r *http.Request) { api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("no rows deleted for server capability"), nil) return } - - api.WriteResp(w, r, "Successfully deleted server capability "+name) + alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was deleted.") + api.WriteAlertsObj(w, r, http.StatusOK, alerts, name) return } From 24ff1415d970f5e2eae47118d889fabf6095340c Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Thu, 15 Dec 2022 13:33:39 -0700 Subject: [PATCH 17/21] Set Location header for CreateServerCapabilities() and added check for sql.ErrNoRows --- .../servercapability/servercapability.go | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index 381216cf4d..d8737deeb0 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -20,6 +20,7 @@ package servercapability */ import ( + "database/sql" "encoding/json" "fmt" "net/http" @@ -229,6 +230,10 @@ func UpdateServerCapability(w http.ResponseWriter, r *http.Request) { err := tx.QueryRow(query, sc.Name, sc.Description, requestedName).Scan(&sc.Name, &sc.Description, &sc.LastUpdated) if err != nil { + if err == sql.ErrNoRows { + api.HandleErr(w, r, tx, http.StatusBadRequest, err, nil) + return + } usrErr, sysErr, code := api.ParseDBError(err) api.HandleErr(w, r, tx, code, usrErr, sysErr) return @@ -269,11 +274,16 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { query := `INSERT INTO server_capability (name, description) VALUES ($1, $2) RETURNING last_updated` err = tx.QueryRow(query, sc.Name, sc.Description).Scan(&sc.LastUpdated) if err != nil { + if err == sql.ErrNoRows { + api.HandleErr(w, r, tx, http.StatusBadRequest, err, nil) + return + } usrErr, sysErr, code := api.ParseDBError(err) api.HandleErr(w, r, tx, code, usrErr, sysErr) return } alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was created.") + w.Header().Set("Location", fmt.Sprintf("/api/%d.%d/server_capabilities$?name=%s", inf.Version.Major, inf.Version.Minor, sc.Name)) api.WriteAlertsObj(w, r, http.StatusCreated, alerts, sc) return } From 0194bc27fa692ddf18b86fa335a51accc614c34b Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Thu, 15 Dec 2022 20:57:36 -0700 Subject: [PATCH 18/21] Added unit test in db_helpers --- .../dbhelpers/db_helpers.go | 4 +- .../dbhelpers/db_helpers_test.go | 52 +++++++++++++++++++ .../servercapability/servercapability.go | 2 +- 3 files changed, 55 insertions(+), 3 deletions(-) diff --git a/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go b/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go index ffee106443..719d91624c 100644 --- a/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go +++ b/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers.go @@ -2186,10 +2186,10 @@ func GetProfileIDDesc(tx *sql.Tx, name string) (id int, desc string) { } // GetSCInfo confirms whether the server capability exists, and an error (if one occurs). -func GetSCInfo(tx *sqlx.Tx, name string) (bool, error) { +func GetSCInfo(tx *sql.Tx, name string) (bool, error) { var count int if err := tx.QueryRow("SELECT count(name) FROM server_capability AS sc WHERE sc.name=$1", name).Scan(&count); err != nil { - return false, fmt.Errorf("getting server capability info: %w", err) + return false, fmt.Errorf("error getting server capability info: %w", err) } if count == 0 { return false, nil diff --git a/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers_test.go b/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers_test.go index b388e8e995..6b532890d8 100644 --- a/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers_test.go +++ b/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers_test.go @@ -408,3 +408,55 @@ func TestGetCDNIDFromName(t *testing.T) { } } + +func TestGetSCInfo(t *testing.T) { + var testCases = []struct { + description string + name string + expectedError error + exists bool + }{ + //{ + // description: "Success: Get valid SC", + // name: "hdd", + // expectedError: nil, + // exists: true, + //}, + { + description: "Failure: SC not in DB", + name: "disk", + expectedError: errors.New("error getting server capability info: sql: no rows in result set"), + exists: false, + }, + } + for _, testCase := range testCases { + t.Run(testCase.description, func(t *testing.T) { + t.Log("Starting test scenario: ", testCase.description) + mockDB, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("an error '%s' was not expected when opening a stub database connection", err) + } + defer mockDB.Close() + + db := sqlx.NewDb(mockDB, "sqlmock") + defer db.Close() + + rows := sqlmock.NewRows([]string{"name"}) + mock.ExpectBegin() + if testCase.exists { + rows = rows.AddRow(testCase.name) + } + mock.ExpectQuery("SELECT").WillReturnRows(rows) + mock.ExpectCommit() + + scExists, err := GetSCInfo(db.MustBegin().Tx, testCase.name) + if testCase.exists != scExists { + t.Errorf("Expected return exists: %t, actual %t", testCase.exists, scExists) + } + + if err == testCase.expectedError { + t.Errorf("getSCInfo expected: %s, actual: %s", testCase.expectedError, err) + } + }) + } +} diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index d8737deeb0..8ab5c24f37 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -298,7 +298,7 @@ func DeleteServerCapability(w http.ResponseWriter, r *http.Request) { defer inf.Close() name := inf.Params["name"] - exists, err := dbhelpers.GetSCInfo(inf.Tx, name) + exists, err := dbhelpers.GetSCInfo(tx, name) if err != nil { api.HandleErr(w, r, tx, http.StatusInternalServerError, nil, err) return From 26da00c1ed53f4062b24893365cb02f5b879ca6c Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Fri, 16 Dec 2022 11:59:40 -0700 Subject: [PATCH 19/21] Addressed review comments-1 --- .../dbhelpers/db_helpers_test.go | 22 +++++++++---------- .../servercapability/servercapability.go | 15 +++++++------ 2 files changed, 19 insertions(+), 18 deletions(-) diff --git a/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers_test.go b/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers_test.go index 6b532890d8..282311caca 100644 --- a/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers_test.go +++ b/traffic_ops/traffic_ops_golang/dbhelpers/db_helpers_test.go @@ -21,6 +21,7 @@ package dbhelpers import ( "context" + "database/sql" "errors" "reflect" "strconv" @@ -416,22 +417,21 @@ func TestGetSCInfo(t *testing.T) { expectedError error exists bool }{ - //{ - // description: "Success: Get valid SC", - // name: "hdd", - // expectedError: nil, - // exists: true, - //}, + { + description: "Success: Get valid SC", + name: "hdd", + expectedError: nil, + exists: true, + }, { description: "Failure: SC not in DB", name: "disk", - expectedError: errors.New("error getting server capability info: sql: no rows in result set"), + expectedError: sql.ErrNoRows, exists: false, }, } for _, testCase := range testCases { t.Run(testCase.description, func(t *testing.T) { - t.Log("Starting test scenario: ", testCase.description) mockDB, mock, err := sqlmock.New() if err != nil { t.Fatalf("an error '%s' was not expected when opening a stub database connection", err) @@ -441,10 +441,10 @@ func TestGetSCInfo(t *testing.T) { db := sqlx.NewDb(mockDB, "sqlmock") defer db.Close() - rows := sqlmock.NewRows([]string{"name"}) mock.ExpectBegin() + rows := sqlmock.NewRows([]string{"count"}) if testCase.exists { - rows = rows.AddRow(testCase.name) + rows = rows.AddRow(1) } mock.ExpectQuery("SELECT").WillReturnRows(rows) mock.ExpectCommit() @@ -454,7 +454,7 @@ func TestGetSCInfo(t *testing.T) { t.Errorf("Expected return exists: %t, actual %t", testCase.exists, scExists) } - if err == testCase.expectedError { + if !errors.Is(err, testCase.expectedError) { t.Errorf("getSCInfo expected: %s, actual: %s", testCase.expectedError, err) } }) diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index 8ab5c24f37..ad694482d3 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -22,6 +22,7 @@ package servercapability import ( "database/sql" "encoding/json" + "errors" "fmt" "net/http" "time" @@ -230,8 +231,8 @@ func UpdateServerCapability(w http.ResponseWriter, r *http.Request) { err := tx.QueryRow(query, sc.Name, sc.Description, requestedName).Scan(&sc.Name, &sc.Description, &sc.LastUpdated) if err != nil { - if err == sql.ErrNoRows { - api.HandleErr(w, r, tx, http.StatusBadRequest, err, nil) + if errors.Is(err, sql.ErrNoRows) { + api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("server capability with name: %s not found", sc.Name), nil) return } usrErr, sysErr, code := api.ParseDBError(err) @@ -266,7 +267,7 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { return } if count == 1 { - api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("server_capability name '%s' already exists.", sc.Name), nil) + api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("server_capability name '%s' already exists", sc.Name), nil) return } @@ -274,8 +275,8 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { query := `INSERT INTO server_capability (name, description) VALUES ($1, $2) RETURNING last_updated` err = tx.QueryRow(query, sc.Name, sc.Description).Scan(&sc.LastUpdated) if err != nil { - if err == sql.ErrNoRows { - api.HandleErr(w, r, tx, http.StatusBadRequest, err, nil) + if errors.Is(err, sql.ErrNoRows) { + api.HandleErr(w, r, tx, http.StatusInternalServerError, fmt.Errorf("error: %w in creating server capability with name: %s", err, sc.Name), nil) return } usrErr, sysErr, code := api.ParseDBError(err) @@ -283,7 +284,7 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { return } alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was created.") - w.Header().Set("Location", fmt.Sprintf("/api/%d.%d/server_capabilities$?name=%s", inf.Version.Major, inf.Version.Minor, sc.Name)) + w.Header().Set("Location", fmt.Sprintf("/api/%d.%d/server_capabilities?name=%s", inf.Version.Major, inf.Version.Minor, sc.Name)) api.WriteAlertsObj(w, r, http.StatusCreated, alerts, sc) return } @@ -333,7 +334,7 @@ func DeleteServerCapability(w http.ResponseWriter, r *http.Request) { return } if rowsAffected == 0 { - api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("no rows deleted for server capability"), nil) + api.HandleErr(w, r, tx, http.StatusInternalServerError, fmt.Errorf("no rows deleted for server capability"), nil) return } alerts := tc.CreateAlerts(tc.SuccessLevel, "server capability was deleted.") From f9b40c8a0c81e26a9223ee5603f22632cc846d45 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Fri, 16 Dec 2022 12:13:56 -0700 Subject: [PATCH 20/21] Updated timestamp on db migration files. --- ...> 2022121612121500_add_description_field_in_sc_table.down.sql} | 0 ... => 2022121612121500_add_description_field_in_sc_table.up.sql} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename traffic_ops/app/db/migrations/{2022112116304800_add_description_in_sc_table.down.sql => 2022121612121500_add_description_field_in_sc_table.down.sql} (100%) rename traffic_ops/app/db/migrations/{2022112116304800_add_description_in_sc_table.up.sql => 2022121612121500_add_description_field_in_sc_table.up.sql} (100%) diff --git a/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.down.sql b/traffic_ops/app/db/migrations/2022121612121500_add_description_field_in_sc_table.down.sql similarity index 100% rename from traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.down.sql rename to traffic_ops/app/db/migrations/2022121612121500_add_description_field_in_sc_table.down.sql diff --git a/traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.up.sql b/traffic_ops/app/db/migrations/2022121612121500_add_description_field_in_sc_table.up.sql similarity index 100% rename from traffic_ops/app/db/migrations/2022112116304800_add_description_in_sc_table.up.sql rename to traffic_ops/app/db/migrations/2022121612121500_add_description_field_in_sc_table.up.sql From 02d4a1429a33b9784e0fa58c7426ce1537f94b11 Mon Sep 17 00:00:00 2001 From: Rima Shah Date: Fri, 16 Dec 2022 13:17:21 -0700 Subject: [PATCH 21/21] Reverting error message punctuation since it causes TP errors. --- .../traffic_ops_golang/servercapability/servercapability.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go index ad694482d3..8d9d60e442 100644 --- a/traffic_ops/traffic_ops_golang/servercapability/servercapability.go +++ b/traffic_ops/traffic_ops_golang/servercapability/servercapability.go @@ -267,7 +267,7 @@ func CreateServerCapability(w http.ResponseWriter, r *http.Request) { return } if count == 1 { - api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("server_capability name '%s' already exists", sc.Name), nil) + api.HandleErr(w, r, tx, http.StatusBadRequest, fmt.Errorf("server_capability name '%s' already exists.", sc.Name), nil) return }