Merge pull request #4 from jwforres/svc-cat-discovery

Optionally run API discovery on service catalog

dist/origin-web-common.js

@@ -91,37 +91,39 @@ hawtioPluginLoader.registerPreBootstrapTask(function(next) {
   //   }
   // }
   var apisBaseURL = protocol + window.OPENSHIFT_CONFIG.apis.hostPort + window.OPENSHIFT_CONFIG.apis.prefix;
-  var apisDeferred = $.get(apisBaseURL)
-    .then(function(data) {
-      var apisDeferredVersions = [];
-      _.each(data.groups, function(apiGroup) {
-        var group = {
-          name: apiGroup.name,
-          preferredVersion: apiGroup.preferredVersion.version,
-          versions: {}
+  var getGroups = function(baseURL, hostPrefix, data) {
+    var apisDeferredVersions = [];
+    _.each(data.groups, function(apiGroup) {
+      var group = {
+        name: apiGroup.name,
+        preferredVersion: apiGroup.preferredVersion.version,
+        versions: {},
+        hostPrefix: hostPrefix
+      };
+      apis[group.name] = group;
+      _.each(apiGroup.versions, function(apiVersion) {
+        var versionStr = apiVersion.version;
+        group.versions[versionStr] = {
+          version: versionStr,
+          groupVersion: apiVersion.groupVersion
         };
-        apis[group.name] = group;
-        _.each(apiGroup.versions, function(apiVersion) {
-          var versionStr = apiVersion.version;
-          group.versions[versionStr] = {
-            version: versionStr,
-            groupVersion: apiVersion.groupVersion
-          };
-          apisDeferredVersions.push($.get(apisBaseURL + "/" + apiVersion.groupVersion)
-            .done(function(data) {
-              group.versions[versionStr].resources = _.indexBy(data.resources, 'name');
-            })
-            .fail(function(data, textStatus, jqXHR) {
-              API_DISCOVERY_ERRORS.push({
-                data: data,
-                textStatus: textStatus,
-                xhr: jqXHR
-              });
-            }));
-        });
+        apisDeferredVersions.push($.get(baseURL + "/" + apiVersion.groupVersion)
+          .done(function(data) {
+            group.versions[versionStr].resources = _.indexBy(data.resources, 'name');
+          })
+          .fail(function(data, textStatus, jqXHR) {
+            API_DISCOVERY_ERRORS.push({
+              data: data,
+              textStatus: textStatus,
+              xhr: jqXHR
+            });
+          }));
       });
-      return $.when.apply(this, apisDeferredVersions);
-    }, function(data, textStatus, jqXHR) {
+    });
+    return $.when.apply(this, apisDeferredVersions);
+  };
+  var apisDeferred = $.get(apisBaseURL)
+    .then(_.partial(getGroups, apisBaseURL, null), function(data, textStatus, jqXHR) {
       API_DISCOVERY_ERRORS.push({
         data: data,
         textStatus: textStatus,
@@ -129,6 +131,21 @@ hawtioPluginLoader.registerPreBootstrapTask(function(next) {
       });
     });
 
+  // Additional servers can be defined for debugging and prototyping against new servers not yet served by the aggregator
+  // There can not be any conflicts in the groups/resources from these API servers.
+  var additionalDeferreds = [];
+  _.each(window.OPENSHIFT_CONFIG.additionalServers, function(server) {
+   var baseURL = server.protocol + "://" + server.hostPort + server.prefix;
+   additionalDeferreds.push($.get(baseURL)
+    .then(_.partial(getGroups, baseURL, server), function(data, textStatus, jqXHR) {
+      API_DISCOVERY_ERRORS.push({
+        data: data,
+        textStatus: textStatus,
+        xhr: jqXHR
+      });
+    }));
+  });
+
   // Will be called on success or failure
   var discoveryFinished = function() {
     window.OPENSHIFT_CONFIG.api.k8s.resources = api.k8s;
@@ -139,7 +156,13 @@ hawtioPluginLoader.registerPreBootstrapTask(function(next) {
     }
     next();
   };
-  $.when(k8sDeferred,osDeferred,apisDeferred).always(discoveryFinished);
+  var allDeferreds = [
+    k8sDeferred,
+    osDeferred,
+    apisDeferred
+  ];
+  allDeferreds = allDeferreds.concat(additionalDeferreds);
+  $.when.apply(this, allDeferreds).always(discoveryFinished);
 });
 
 
@@ -393,17 +416,21 @@ angular.module('openshiftCommon')
 
     resource = toResourceGroupVersion(resource);
     var primaryResource = resource.primaryResource();
-
+    var discoveredResource;
     // API info for resources in an API group, if the resource was not found during discovery return undefined
     if (resource.group) {
-      if (!_.get(APIS_CFG, ["groups", resource.group, "versions", resource.version, "resources", primaryResource])) {
+      discoveredResource = _.get(APIS_CFG, ["groups", resource.group, "versions", resource.version, "resources", primaryResource]);
+      if (!discoveredResource) {
         return undefined;
       }
+      var hostPrefixObj = _.get(APIS_CFG, ["groups", resource.group, 'hostPrefix']) || APIS_CFG;
       return {
-        hostPort: APIS_CFG.hostPort,
-        prefix:   APIS_CFG.prefix,
+        protocol: hostPrefixObj.protocol,
+        hostPort: hostPrefixObj.hostPort,
+        prefix:   hostPrefixObj.prefix,
         group:    resource.group,
-        version:  resource.version
+        version:  resource.version,
+        namespaced: discoveredResource.namespaced
       };
     }
 
@@ -412,13 +439,15 @@ angular.module('openshiftCommon')
     var api;
     for (var apiName in API_CFG) {
       api = API_CFG[apiName];
-      if (!_.get(api, ["resources", resource.version, primaryResource])) {
+      discoveredResource = _.get(api, ["resources", resource.version, primaryResource]);
+      if (!discoveredResource) {
         continue;
       }
       return {
         hostPort: api.hostPort,
         prefix:   api.prefix,
-        version:  resource.version
+        version:  resource.version,
+        namespaced: discoveredResource.namespaced
       };
     }
     return undefined;
@@ -2193,7 +2222,12 @@ DataService.prototype.createStream = function(resource, name, context, opts, isR
       params.namespace = context.namespace;
     }
 
-    var namespaceInPath = params.namespace;
+    if (apiInfo.namespaced && !params.namespace) {
+      Logger.error("_urlForResource called for a namespaced resource but no namespace provided", resource, arguments);
+      return null;
+    }
+
+    var namespaceInPath = apiInfo.namespaced;
     var namespace = null;
     if (namespaceInPath) {
       namespace = params.namespace;
@@ -2202,7 +2236,7 @@ DataService.prototype.createStream = function(resource, name, context, opts, isR
     }
     var template;
     var templateOptions = {
-      protocol: protocol,
+      protocol: apiInfo.protocol || protocol,
       hostPort: apiInfo.hostPort,
       prefix: apiInfo.prefix,
       group: apiInfo.group,

src/openshiftCommon.module.js

@@ -91,37 +91,39 @@ hawtioPluginLoader.registerPreBootstrapTask(function(next) {
   //   }
   // }
   var apisBaseURL = protocol + window.OPENSHIFT_CONFIG.apis.hostPort + window.OPENSHIFT_CONFIG.apis.prefix;
-  var apisDeferred = $.get(apisBaseURL)
-    .then(function(data) {
-      var apisDeferredVersions = [];
-      _.each(data.groups, function(apiGroup) {
-        var group = {
-          name: apiGroup.name,
-          preferredVersion: apiGroup.preferredVersion.version,
-          versions: {}
+  var getGroups = function(baseURL, hostPrefix, data) {
+    var apisDeferredVersions = [];
+    _.each(data.groups, function(apiGroup) {
+      var group = {
+        name: apiGroup.name,
+        preferredVersion: apiGroup.preferredVersion.version,
+        versions: {},
+        hostPrefix: hostPrefix
+      };
+      apis[group.name] = group;
+      _.each(apiGroup.versions, function(apiVersion) {
+        var versionStr = apiVersion.version;
+        group.versions[versionStr] = {
+          version: versionStr,
+          groupVersion: apiVersion.groupVersion
         };
-        apis[group.name] = group;
-        _.each(apiGroup.versions, function(apiVersion) {
-          var versionStr = apiVersion.version;
-          group.versions[versionStr] = {
-            version: versionStr,
-            groupVersion: apiVersion.groupVersion
-          };
-          apisDeferredVersions.push($.get(apisBaseURL + "/" + apiVersion.groupVersion)
-            .done(function(data) {
-              group.versions[versionStr].resources = _.indexBy(data.resources, 'name');
-            })
-            .fail(function(data, textStatus, jqXHR) {
-              API_DISCOVERY_ERRORS.push({
-                data: data,
-                textStatus: textStatus,
-                xhr: jqXHR
-              });
-            }));
-        });
+        apisDeferredVersions.push($.get(baseURL + "/" + apiVersion.groupVersion)
+          .done(function(data) {
+            group.versions[versionStr].resources = _.indexBy(data.resources, 'name');
+          })
+          .fail(function(data, textStatus, jqXHR) {
+            API_DISCOVERY_ERRORS.push({
+              data: data,
+              textStatus: textStatus,
+              xhr: jqXHR
+            });
+          }));
       });
-      return $.when.apply(this, apisDeferredVersions);
-    }, function(data, textStatus, jqXHR) {
+    });
+    return $.when.apply(this, apisDeferredVersions);
+  };
+  var apisDeferred = $.get(apisBaseURL)
+    .then(_.partial(getGroups, apisBaseURL, null), function(data, textStatus, jqXHR) {
       API_DISCOVERY_ERRORS.push({
         data: data,
         textStatus: textStatus,
@@ -129,6 +131,21 @@ hawtioPluginLoader.registerPreBootstrapTask(function(next) {
       });
     });
 
+  // Additional servers can be defined for debugging and prototyping against new servers not yet served by the aggregator
+  // There can not be any conflicts in the groups/resources from these API servers.
+  var additionalDeferreds = [];
+  _.each(window.OPENSHIFT_CONFIG.additionalServers, function(server) {
+   var baseURL = server.protocol + "://" + server.hostPort + server.prefix;
+   additionalDeferreds.push($.get(baseURL)
+    .then(_.partial(getGroups, baseURL, server), function(data, textStatus, jqXHR) {
+      API_DISCOVERY_ERRORS.push({
+        data: data,
+        textStatus: textStatus,
+        xhr: jqXHR
+      });
+    }));
+  });
+
   // Will be called on success or failure
   var discoveryFinished = function() {
     window.OPENSHIFT_CONFIG.api.k8s.resources = api.k8s;
@@ -139,7 +156,13 @@ hawtioPluginLoader.registerPreBootstrapTask(function(next) {
     }
     next();
   };
-  $.when(k8sDeferred,osDeferred,apisDeferred).always(discoveryFinished);
+  var allDeferreds = [
+    k8sDeferred,
+    osDeferred,
+    apisDeferred
+  ];
+  allDeferreds = allDeferreds.concat(additionalDeferreds);
+  $.when.apply(this, allDeferreds).always(discoveryFinished);
 });
 
 

src/services/apiService.js

@@ -211,17 +211,21 @@ angular.module('openshiftCommon')
 
     resource = toResourceGroupVersion(resource);
     var primaryResource = resource.primaryResource();
-
+    var discoveredResource;
     // API info for resources in an API group, if the resource was not found during discovery return undefined
     if (resource.group) {
-      if (!_.get(APIS_CFG, ["groups", resource.group, "versions", resource.version, "resources", primaryResource])) {
+      discoveredResource = _.get(APIS_CFG, ["groups", resource.group, "versions", resource.version, "resources", primaryResource]);
+      if (!discoveredResource) {
         return undefined;
       }
+      var hostPrefixObj = _.get(APIS_CFG, ["groups", resource.group, 'hostPrefix']) || APIS_CFG;
       return {
-        hostPort: APIS_CFG.hostPort,
-        prefix:   APIS_CFG.prefix,
+        protocol: hostPrefixObj.protocol,
+        hostPort: hostPrefixObj.hostPort,
+        prefix:   hostPrefixObj.prefix,
         group:    resource.group,
-        version:  resource.version
+        version:  resource.version,
+        namespaced: discoveredResource.namespaced
       };
     }
 
@@ -230,13 +234,15 @@ angular.module('openshiftCommon')
     var api;
     for (var apiName in API_CFG) {
       api = API_CFG[apiName];
-      if (!_.get(api, ["resources", resource.version, primaryResource])) {
+      discoveredResource = _.get(api, ["resources", resource.version, primaryResource]);
+      if (!discoveredResource) {
         continue;
       }
       return {
         hostPort: api.hostPort,
         prefix:   api.prefix,
-        version:  resource.version
+        version:  resource.version,
+        namespaced: discoveredResource.namespaced
       };
     }
     return undefined;

src/services/dataService.js

@@ -1223,7 +1223,12 @@ DataService.prototype.createStream = function(resource, name, context, opts, isR
       params.namespace = context.namespace;
     }
 
-    var namespaceInPath = params.namespace;
+    if (apiInfo.namespaced && !params.namespace) {
+      Logger.error("_urlForResource called for a namespaced resource but no namespace provided", resource, arguments);
+      return null;
+    }
+
+    var namespaceInPath = apiInfo.namespaced;
     var namespace = null;
     if (namespaceInPath) {
       namespace = params.namespace;
@@ -1232,7 +1237,7 @@ DataService.prototype.createStream = function(resource, name, context, opts, isR
     }
     var template;
     var templateOptions = {
-      protocol: protocol,
+      protocol: apiInfo.protocol || protocol,
       hostPort: apiInfo.hostPort,
       prefix: apiInfo.prefix,
       group: apiInfo.group,

test/spec/services/dataServiceSpec.js

@@ -29,19 +29,19 @@ describe("DataService", function(){
       [{resource:'Users'},             "http://localhost:8443/oapi/v1/users"],
       [{resource:'oauthaccesstokens'}, "http://localhost:8443/oapi/v1/oauthaccesstokens"],
       [{resource:'OAuthAccessTokens'}, "http://localhost:8443/oapi/v1/oauthaccesstokens"],
-      [{resource:'pods'},              "http://localhost:8443/api/v1/pods"],
-      [{resource:'Pods'},              "http://localhost:8443/api/v1/pods"],
+      [{resource:'nodes'},              "http://localhost:8443/api/v1/nodes"],
+      [{resource:'Nodes'},              "http://localhost:8443/api/v1/nodes"],
 
       // OpenShift resource
-      [{resource:'builds'                             }, "http://localhost:8443/oapi/v1/builds"],
+      [{resource:'clusterroles'                       }, "http://localhost:8443/oapi/v1/clusterroles"],
       [{resource:'builds', namespace:"foo"            }, "http://localhost:8443/oapi/v1/namespaces/foo/builds"],
-      [{resource:'builds',                  name:"bar"}, "http://localhost:8443/oapi/v1/builds/bar"],
+      [{resource:'clusterroles',            name:"bar"}, "http://localhost:8443/oapi/v1/clusterroles/bar"],
       [{resource:'builds', namespace:"foo", name:"bar"}, "http://localhost:8443/oapi/v1/namespaces/foo/builds/bar"],
 
       // k8s resource
-      [{resource:'replicationcontrollers'                             }, "http://localhost:8443/api/v1/replicationcontrollers"],
+      [{resource:'nodes'                                              }, "http://localhost:8443/api/v1/nodes"],
       [{resource:'replicationcontrollers', namespace:"foo"            }, "http://localhost:8443/api/v1/namespaces/foo/replicationcontrollers"],
-      [{resource:'replicationcontrollers',                  name:"bar"}, "http://localhost:8443/api/v1/replicationcontrollers/bar"],
+      [{resource:'nodes',                                   name:"bar"}, "http://localhost:8443/api/v1/nodes/bar"],
       [{resource:'replicationcontrollers', namespace:"foo", name:"bar"}, "http://localhost:8443/api/v1/namespaces/foo/replicationcontrollers/bar"],
 
       // Subresources and webhooks
@@ -76,16 +76,16 @@ describe("DataService", function(){
       [{resource:'pods/proxy', name:"mypod", namespace:"myns", myparam1:"myvalue"}, "http://localhost:8443/api/v1/namespaces/myns/pods/mypod/proxy?myparam1=myvalue"],
 
       // Different API versions
-      [{resource:'builds',version:'v1beta3'}, null],
-      [{resource:'builds',version:'v1'     }, "http://localhost:8443/oapi/v1/builds"],
-      [{resource:'builds',version:'unknown'}, null],
+      [{resource:'clusterroles',version:'v1beta3'}, null],
+      [{resource:'clusterroles',version:'v1'     }, "http://localhost:8443/oapi/v1/clusterroles"],
+      [{resource:'clusterroles',version:'unknown'}, null],
 
-      [{resource:'pods',  version:'v1beta3'}, null],
-      [{resource:'pods',  version:'v1'     }, "http://localhost:8443/api/v1/pods"],
-      [{resource:'pods',  version:'unknown'}, null],
+      [{resource:'nodes',  version:'v1beta3'}, null],
+      [{resource:'nodes',  version:'v1'     }, "http://localhost:8443/api/v1/nodes"],
+      [{resource:'nodes',  version:'unknown'}, null],
 
       // Different API groups
-      [{resource:'jobs',  group: 'extensions', version:'v1beta1'}, "http://localhost:8443/apis/extensions/v1beta1/jobs"]
+      [{resource:'jobs',  group: 'extensions', version:'v1beta1', namespace:"foo"}, "http://localhost:8443/apis/extensions/v1beta1/namespaces/foo/jobs"]
     ];
 
     angular.forEach(tc, function(item) {