[Issue-1402] - adds profile list to GET parameters response to help identify orphan…

docs/source/development/traffic_ops_api/v12/parameter.rst

@@ -44,41 +44,47 @@ Parameter
   +------------------+---------+--------------------------------------------------------------------------------+
   |    Parameter     |  Type   |                    Description                                                 |
   +==================+=========+================================================================================+
-  | ``last_updated`` | string  | The Time / Date this server entry was last updated                             |
+  | ``lastUpdated``  | string  | The Time / Date this server entry was last updated                             |
   +------------------+---------+--------------------------------------------------------------------------------+
   | ``secure``       | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
   +------------------+---------+--------------------------------------------------------------------------------+
   | ``value``        | string  | The parameter value, only visible to admin if secure is true                   |
   +------------------+---------+--------------------------------------------------------------------------------+
   | ``name``         | string  | The parameter name                                                             |
   +------------------+---------+--------------------------------------------------------------------------------+
-  | ``config_file``  | string  | The parameter config_file                                                      |
+  | ``configFile``   | string  | The parameter config_file                                                      |
+  +------------------+---------+--------------------------------------------------------------------------------+
+  | ``profiles``     | array   | An array of profiles attached to this parameter.                               |
   +------------------+---------+--------------------------------------------------------------------------------+
 
   **Response Example** ::
 
     {
      "response": [
         {
-           "last_updated": "2012-09-17 21:41:22",
+           "lastUpdated": "2012-09-17 21:41:22",
            "secure": false,
            "value": "foo.bar.net",
            "name": "domain_name",
-           "config_file": "FooConfig.xml"
+           "configFile": "FooConfig.xml",
+           "profiles": [ "EDGE-FOO, MID-FOO" ]
         },
         {
-           "last_updated": "2012-09-17 21:41:22",
+           "lastUpdated": "2012-09-17 21:41:22",
            "secure": false,
            "value": "0,1,2,3,4,5,6",
            "name": "Drive_Letters",
-           "config_file": "storage.config"
+           "configFile": "storage.config",
+           "profiles": [ "EDGE-FOO, MID-FOO" ]
+
         },
         {
-           "last_updated": "2012-09-17 21:41:22",
+           "lastUpdated": "2012-09-17 21:41:22",
            "secure": true,
            "value": "STRING __HOSTNAME__",
            "name": "CONFIG proxy.config.proxy_name",
-           "config_file": "records.config"
+           "configFile": "records.config"
+           "profiles": [ ]
         }
      ],
     }

lib/go-tc/parameters.go

@@ -1,5 +1,7 @@
 package tc
 
+import "encoding/json"
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -26,10 +28,11 @@ type ParametersResponse struct {
 
 // Parameter ...
 type Parameter struct {
-	ConfigFile  string   `json:"configFile" db:"config_file"`
-	ID          int      `json:"id" db:"id"`
-	LastUpdated Time `json:"lastUpdated" db:"last_updated"`
-	Name        string   `json:"name" db:"name"`
-	Secure      bool     `json:"secure" db:"secure"`
-	Value       string   `json:"value" db:"value"`
+	ConfigFile  string          `json:"configFile" db:"config_file"`
+	ID          int             `json:"id" db:"id"`
+	LastUpdated Time            `json:"lastUpdated" db:"last_updated"`
+	Name        string          `json:"name" db:"name"`
+	Profiles    json.RawMessage `json:"profiles" db:"profiles"`
+	Secure      bool            `json:"secure" db:"secure"`
+	Value       string          `json:"value" db:"value"`
 }

traffic_ops/traffic_ops_golang/parameters.go

@@ -121,13 +121,16 @@ func getParameters(v url.Values, db *sqlx.DB, privLevel int) ([]tc.Parameter, er
 func selectParametersQuery() string {
 
 	query := `SELECT
-config_file,
-id,
-last_updated,
-name,
-value,
-secure
-
-FROM parameter p`
+p.config_file,
+p.id,
+p.last_updated,
+p.name,
+p.value,
+p.secure,
+COALESCE(array_to_json(array_agg(pr.name) FILTER (WHERE pr.name IS NOT NULL)), '[]') AS profiles
+FROM parameter p
+LEFT JOIN profile_parameter pp ON p.id = pp.parameter
+LEFT JOIN profile pr ON pp.profile = pr.id
+GROUP BY p.config_file, p.id, p.last_updated, p.name, p.value, p.secure`
 	return query
 }

traffic_ops/traffic_ops_golang/parameters_test.go

@@ -30,6 +30,7 @@ import (
 	"github.com/jmoiron/sqlx"
 
 	sqlmock "gopkg.in/DATA-DOG/go-sqlmock.v1"
+	"encoding/json"
 )
 
 func getTestParameters() []tc.Parameter {
@@ -39,6 +40,7 @@ func getTestParameters() []tc.Parameter {
 		ID:          1,
 		LastUpdated: tc.Time{Time: time.Now()},
 		Name:        "paramname1",
+		Profiles:    json.RawMessage(`["foo","bar"]`),
 		Secure:      false,
 		Value:       "val1",
 	}
@@ -48,6 +50,7 @@ func getTestParameters() []tc.Parameter {
 	testParameter2.Name = "paramname2"
 	testParameter2.Value = "val2"
 	testParameter2.ConfigFile = "some.config"
+	testParameter2.Profiles = json.RawMessage(`["foo","baz"]`)
 	parameters = append(parameters, testParameter2)
 
 	return parameters
@@ -75,6 +78,7 @@ func TestGetParameters(t *testing.T) {
 			ts.ID,
 			ts.LastUpdated,
 			ts.Name,
+			ts.Profiles,
 			ts.Secure,
 			ts.Value,
 		)

traffic_ops/traffic_ops_golang/routes.go

@@ -62,7 +62,7 @@ func Routes(d ServerData) ([]Route, http.Handler, error) {
 		//HwInfo
 		{1.2, http.MethodGet, `hwinfo-wip/?(\.json)?$`, hwInfoHandler(d.DB), HWInfoPrivLevel, Authenticated, nil},
 		//Parameters
-		{1.2, http.MethodGet, `parameters/?(\.json)?$`, parametersHandler(d.DB), ParametersPrivLevel, Authenticated, nil},
+		{1.3, http.MethodGet, `parameters/?(\.json)?$`, parametersHandler(d.DB), ParametersPrivLevel, Authenticated, nil},
 		//Regions
 		{1.2, http.MethodGet, `regions/?(\.json)?$`, regionsHandler(d.DB), RegionsPrivLevel, Authenticated, nil},
 		{1.2, http.MethodGet, `regions/{id}$`, regionsHandler(d.DB), RegionsPrivLevel, Authenticated, nil},

traffic_ops/traffic_ops_golang/system_info_test.go

@@ -30,6 +30,7 @@ import (
 	"github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/auth"
 	"github.com/apache/incubator-trafficcontrol/traffic_ops/traffic_ops_golang/test"
 	"github.com/jmoiron/sqlx"
+	"encoding/json"
 )
 
 var sysInfoParameters = []tc.Parameter{
@@ -38,6 +39,7 @@ var sysInfoParameters = []tc.Parameter{
 		ID:          1,
 		LastUpdated: tc.Time{Time: time.Now()},
 		Name:        "paramname1",
+		Profiles:    json.RawMessage(`["foo","bar"]`),
 		Secure:      false,
 		Value:       "val1",
 	},
@@ -47,6 +49,7 @@ var sysInfoParameters = []tc.Parameter{
 		ID:          2,
 		LastUpdated: tc.Time{Time: time.Now()},
 		Name:        "paramname2",
+		Profiles:    json.RawMessage(`["foo","bar"]`),
 		Secure:      false,
 		Value:       "val2",
 	},
@@ -73,6 +76,7 @@ func TestGetSystemInfo(t *testing.T) {
 			ts.ID,
 			ts.LastUpdated,
 			ts.Name,
+			ts.Profiles,
 			ts.Secure,
 			ts.Value,
 		)

traffic_portal/app/src/common/modules/table/parameters/_table.parameters.scss

@@ -0,0 +1,25 @@
+/*
+
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+*/
+
+.param-value {
+  max-width: 300px;
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  display: inline-block;
+  margin-bottom: -5px;
+}

traffic_portal/app/src/common/modules/table/parameters/table.parameters.tpl.html

@@ -37,6 +37,7 @@
                     <th>Config File</th>
                     <th>Value</th>
                     <th>Secure</th>
+                    <th>Profiles</th>
                 </tr>
             </thead>
             <tbody>
@@ -45,6 +46,7 @@
                     <td data-search="^{{::p.configFile}}$">{{::p.configFile}}</td>
                     <td data-search="^{{::p.value}}$">{{::p.value}}</td>
                     <td data-search="^{{::p.secure}}$">{{::p.secure}}</td>
+                    <td data-search="{{::p.profiles}}" uib-popover="{{::p.profiles.sort().join(',\n')}}" popover-title="Profiles" popover-trigger="mouseenter" popover-placement="left" popover-append-to-body="true">{{p.profiles.length}}</td>
                 </tr>
             </tbody>
         </table>

traffic_portal/app/src/styles/main.scss

@@ -33,6 +33,7 @@ $fa-font-path: "../assets/fonts";
 @import "../common/modules/message/message";
 @import "../common/modules/navigation/navigation";
 @import "../common/modules/table/table";
+@import "../common/modules/table/parameters/table.parameters";
 @import "../common/modules/release/release";
 @import "../common/modules/widget/capacity/widget.capacity";
 @import "../common/modules/widget/cacheGroups/widget.cacheGroups";