Adding "Run on OpenShift" functionality #884
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| 'use strict'; | ||
|
|
||
| /** | ||
| * @ngdoc function | ||
| * @name openshiftConsole.controller:CreateFromURLController | ||
| * @description | ||
| * Controller of the openshiftConsole | ||
| */ | ||
| angular.module('openshiftConsole') | ||
| .controller('CreateFromURLController', function ($scope, $routeParams, $location, $filter, AuthService, DataService, AlertMessageService, Navigate, ProjectsService ) { | ||
| AuthService.withUser(); | ||
|
|
||
| AlertMessageService.getAlerts().forEach(function(alert) { | ||
| $scope.alerts[alert.name] = alert.data; | ||
| }); | ||
| AlertMessageService.clearAlerts(); | ||
|
|
||
| $scope.alerts = {}; | ||
| $scope.selected = {}; | ||
|
|
||
| var alertInvalidImageStream = function(imageStream) { | ||
| $scope.alerts.invalidImageStream = { | ||
| type: "error", | ||
| message: "The requested image stream \"" + imageStream + "\" could not be loaded." | ||
| }; | ||
| }; | ||
|
|
||
| var alertInvalidImageTag = function(imageTag) { | ||
| $scope.alerts.invalidImageTag = { | ||
| type: "error", | ||
| message: "The requested image stream tag \"" + imageTag + "\" could not be loaded." | ||
| }; | ||
| }; | ||
|
|
||
| var alertInvalidName = function(name) { | ||
| $scope.alerts.invalidImageStream = { | ||
| type: "error", | ||
| message: "The app name \"" + name + "\" is not valid. An app name is an alphanumeric (a-z, and 0-9) string with a maximum length of 24 characters, where the first character is a letter (a-z), and the '-' character is allowed anywhere except the first or last character." | ||
| }; | ||
| }; | ||
|
|
||
| var alertInvalidNamespace = function(namespace) { | ||
| $scope.alerts.invalidNamespace = { | ||
| type: "error", | ||
| message: "Resources from the namespace \"" + namespace + "\" are not permitted." | ||
| }; | ||
| }; | ||
|
|
||
| var alertInvalidTemplate = function(template) { | ||
| $scope.alerts.invalidTemplate = { | ||
| type: "error", | ||
| message: "The requested template \"" + template + "\" could not be loaded." | ||
| }; | ||
| }; | ||
|
|
||
| var alertResourceRequired = function() { | ||
| $scope.alerts.resourceRequired = { | ||
| type: "error", | ||
| message: "An image stream or template is required." | ||
| }; | ||
| }; | ||
|
|
||
| var showInvalidResource = function() { | ||
| $scope.alerts.invalidResource = { | ||
| type: "error", | ||
| message: "Image streams and templates cannot be combined." | ||
| }; | ||
| }; | ||
|
|
||
| var getTemplateParamsMap = function () { | ||
| try { | ||
| return $routeParams.templateParamsMap && JSON.parse($routeParams.templateParamsMap) || {}; | ||
| } | ||
| catch (e) { | ||
| $scope.alerts.invalidTemplateParams = { | ||
| type: "error", | ||
| message: "The templateParamsMap is not valid JSON. " + e | ||
| }; | ||
| } | ||
| }; | ||
|
|
||
| var namespaceWhitelist = window.OPENSHIFT_CONSTANTS.CREATE_FROM_URL_WHITELIST; | ||
| var whiteListedCreateDetailsKeys = ['namespace', 'name', 'imageStream', 'imageTag', 'sourceURI', 'sourceRef', 'contextDir', 'template', 'templateParamsMap']; | ||
| var createDetails = _.pick($routeParams, function(value, key) { | ||
| // routeParams without a value (e.g., ?name&) return true, which results in "true" displaying in the UI | ||
| return _.contains(whiteListedCreateDetailsKeys, key) && _.isString(value); | ||
| }); | ||
| // if no namespace is specified, set it to 'openshift' | ||
| createDetails.namespace = createDetails.namespace || 'openshift'; | ||
|
|
||
| var validateName = function (name) { | ||
| return name.length < 25 && /^[a-z]([-a-z0-9]*[a-z0-9])?$/.test(name); | ||
| }; | ||
|
|
||
| var getResources = function() { | ||
| if (createDetails.imageStream) { | ||
| DataService | ||
| .get("imagestreams", createDetails.imageStream, {namespace: createDetails.namespace}, { | ||
| errorNotification: false | ||
| }) | ||
| .then(function(imageStream) { | ||
| $scope.imageStream = imageStream; | ||
| DataService | ||
| .get("imagestreamtags", imageStream.metadata.name + ":" + createDetails.imageTag, {namespace: createDetails.namespace}, { | ||
| errorNotification: false | ||
| }) | ||
| .then(function(imageStreamTag){ | ||
| $scope.imageStreamTag = imageStreamTag; | ||
| $scope.validationPassed = true; | ||
| $scope.resource = imageStreamTag; | ||
| createDetails.displayName = $filter('displayName')(imageStreamTag); | ||
| }, function(){ | ||
| alertInvalidImageTag(createDetails.imageTag); | ||
| }); | ||
| }, function() { | ||
| alertInvalidImageStream(createDetails.imageStream); | ||
| }); | ||
| } | ||
| if (createDetails.template) { | ||
| DataService | ||
| .get("templates", createDetails.template, {namespace: createDetails.namespace}, { | ||
| errorNotification: false | ||
| }) | ||
| .then(function(template) { | ||
| $scope.template = template; | ||
| if(getTemplateParamsMap()) { | ||
| $scope.validationPassed = true; | ||
| $scope.resource = template; | ||
| } | ||
| }, function() { | ||
| alertInvalidTemplate(createDetails.template); | ||
| }); | ||
| } | ||
| }; | ||
|
|
||
| if (!(_.includes(namespaceWhitelist, createDetails.namespace))) { | ||
| alertInvalidNamespace(createDetails.namespace); | ||
| } else { | ||
| if (createDetails.imageStream && createDetails.template) { | ||
| showInvalidResource(); | ||
| } else if (!(createDetails.imageStream) && !(createDetails.template)) { | ||
| alertResourceRequired(); | ||
| } else if (createDetails.name && !(validateName(createDetails.name))) { | ||
| alertInvalidName(createDetails.name); | ||
| } else { | ||
| getResources(); | ||
| } | ||
| } | ||
|
|
||
| angular.extend($scope, { | ||
| createDetails: createDetails, | ||
| createWithProject: function(projectName) { | ||
| projectName = projectName || $scope.selected.project.metadata.name; | ||
| var url = $routeParams.imageStream ? | ||
| Navigate.createFromImageURL($scope.imageStream, createDetails.imageTag, projectName, createDetails) : | ||
| Navigate.createFromTemplateURL($scope.template, projectName, createDetails); | ||
| $location.url(url); | ||
| } | ||
| }); | ||
|
|
||
| $scope.projects = {}; | ||
| $scope.canCreateProject = undefined; | ||
|
|
||
| DataService | ||
| .list("projects", $scope) | ||
| .then(function(items) { | ||
| $scope.loaded = true; | ||
| $scope.projects = $filter('orderByDisplayName')(items.by("metadata.name")); | ||
| $scope.noProjects = (_.isEmpty($scope.projects)); | ||
| }); | ||
|
|
||
|
|
||
| // Test if the user can submit project requests. Handle error notifications | ||
| // ourselves because 403 responses are expected. | ||
| ProjectsService | ||
| .canCreate() | ||
| .then(function() { | ||
| $scope.canCreateProject = true; | ||
| }, function() { | ||
| $scope.canCreateProject = false; | ||
| }); | ||
|
|
||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,30 +18,4 @@ angular.module('openshiftConsole') | |
| }); | ||
| AlertMessageService.clearAlerts(); | ||
|
|
||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,8 +31,7 @@ angular.module('openshiftConsole') | |
| keyValueEditorUtils, | ||
| Constants) { | ||
|
|
||
| var name = $routeParams.template; | ||
|
There was a problem hiding this comment. Need to update at least Navigate service as well since we've changed a query parameter name. |
||
|
|
||
| // If the namespace is not defined, that indicates that the processed Template should be obtained from the 'CachedTemplateService' | ||
| var namespace = $routeParams.namespace || ""; | ||
|
|
@@ -44,6 +43,7 @@ angular.module('openshiftConsole') | |
|
|
||
| $scope.emptyMessage = "Loading..."; | ||
| $scope.alerts = {}; | ||
| $scope.alertsTop = {}; | ||
| $scope.projectName = $routeParams.project; | ||
| $scope.projectPromise = $.Deferred(); | ||
| $scope.labels = []; | ||
|
|
@@ -80,6 +80,18 @@ angular.module('openshiftConsole') | |
| var builderImage = $parse('spec.strategy.sourceStrategy.from || spec.strategy.dockerStrategy.from || spec.strategy.customStrategy.from'); | ||
| var outputImage = $parse('spec.output.to'); | ||
|
|
||
| var getValidTemplateParamsMap = function () { | ||
| try { | ||
| return JSON.parse($routeParams.templateParamsMap); | ||
| } | ||
| catch (e) { | ||
| $scope.alertsTop.invalidTemplateParams = { | ||
| type: "error", | ||
| message: "The templateParamsMap is not valid JSON. " + e | ||
| }; | ||
| } | ||
| }; | ||
|
|
||
| ProjectsService | ||
| .get($routeParams.project) | ||
| .then(_.spread(function(project, context) { | ||
|
|
@@ -356,6 +368,15 @@ angular.module('openshiftConsole') | |
| $scope.parameterDisplayNames[parameter.name] = parameter.displayName || parameter.name; | ||
| }); | ||
|
|
||
| if($routeParams.templateParamsMap) { | ||
| var templateParams = getValidTemplateParamsMap(); | ||
| _.each($scope.template.parameters, function(parameter) { | ||
| if (templateParams[parameter.name]) { | ||
| parameter.value = templateParams[parameter.name]; | ||
|
There was a problem hiding this comment. Did we switch back to array for this controller? I think it would be better to use a map everywhere to be consistent if possible. There was a problem hiding this comment. Not sure I (we) understand the question. $scope.template.parameters is the existing array that was already in use on the page. There was a problem hiding this comment. Sorry, I misread the code. Disregard. |
||
| } | ||
| }); | ||
|
There was a problem hiding this comment. Can use the shorthand (where _.find(params, { name: parameter.name });There was a problem hiding this comment. Any reason to not make the JSON a map? For example, {
"SOURCE_URL_REPOSITORY": "http://github.com/openshift/origin-ruby-example"
}There was a problem hiding this comment. https://github.com/openshift/openshift-ansible/blob/master/roles/openshift_examples/files/examples/v1.4/quickstart-templates/nodejs-mongodb.json#L364 If we do that, then users can only override name and value key values. If we leave it as is, they can override any key values they choose. Do we want to restrict to only name and value values? There was a problem hiding this comment.
Yeah, I don't think they should be able to change anything other than the value for an existing parameter. We should probably show an error if they give the name that does not match a param in the template. |
||
| } | ||
|
|
||
| findTemplateImages($scope.template); | ||
| var imageUsesParameters = function(image) { | ||
| return !_.isEmpty(image.usesParameters); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We typically use
Navigate.toErrorPage()for these types of errors (invalid or conflicting route params)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That was an intentional decision to facilitate the creation of URLs. By throwing an alert on the current page, we can give feedback on specific things that are incorrect while maintaining the context of the query string in the address bar. Do you disagree?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rhamilto So the idea is that I can tweak the URL in the location bar until I get it right? Makes sense.
Is the rest of the page blank? How does that look?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep. It looks like a blank page. I wasn't sure what else to include since it's hard to know what the user is trying to do. Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe some text with help building the URL? Or a link to the docs when they're written?