fixes #1646, #3103 - enable cloning for templates, and add read-only options #1559

stbenjam · 2014-07-03T22:03:26Z

No description provided.

dLobatog · 2014-07-04T17:12:20Z

app/models/config_template.rb

@@ -41,6 +42,12 @@ def to_param
    "#{id}-#{name.parameterize}"
  end

+  def clone
+    template = self.dup


Could you use deep_cloneable to clone the relationships with operating systems at least? https://github.com/theforeman/foreman/blob/develop/app/models/host/managed.rb#L645 is an example

jlsherrill · 2014-07-07T18:30:05Z

app/controllers/config_templates_controller.rb

+      when 'destroy'
+        'destroy'
+      when 'index', 'show', 'clone'
+        'view'


Shouldn't clone require the 'create' permission (even though i realize its not doing much but redirecting to new)?

Host and Host group both use 'view' for clone. I assume because the permission is evaluated on the original object, and you only need to view that one.

Although it is confusing to show a clone link if the user ultimately doesn't have create rights.

ah, then i'm okay with that if the foreman-ers are okay with it :)

It's correct, though the link should only be visible if the user has the create_templates permission (due to access_permissions.rb).

jlsherrill · 2014-07-07T19:24:45Z

When i go to clone a template, the org and location list is empty. I would expect it to have whatever org and location I'm in similar to when i create a new template.

stbenjam · 2014-07-07T21:36:56Z

@jlsherrill What should the behavior be? At the moment, I clone the org and locs from the previous template. I guess I should take only the current taxonomies, if set?

jlsherrill · 2014-07-07T21:55:56Z

@stbenjam i could see an argument for either/both.

a) Since its a clone you'd expect everything I don't change to be the same (the way you've implemented it).
b) As a non-admin user, I might not even have permissions to access those other orgs and locations though (I assume an error would be thrown on the save?).
c) As a user I might expect it to behave the same as new.
d) As a katello user, I would want it to select my current selected org/location as that is more our workflow (user clones to their org to make edits).

For the katello usecase, katello can override the ConfigTemplate#clone method if need be. After thinking about it, i'd probably lean towards a) However I'm not sure about situation b).

domcleal · 2014-07-08T07:22:29Z

app/views/config_templates/_form.html.erb

+             allowed_changes << _("locations")     if show_location_tab?
+             allowed_changes << _("organizations") if show_organization_tab? %>
+        <%= alert :class => 'alert-warning', :header => '',
+                  :text  => icon_text("warning-sign", (_('Note: This template is read only.  You may only change the %s. Please %s it to customize.') %


Use hash syntax when multiple variables are interpolated: http://projects.theforeman.org/projects/foreman/wiki/Translating#Translating-for-developers

Two nitpicks, "read only" should be hyphenated, one space after a period for consistency.

domcleal · 2014-07-08T07:31:57Z

Integration tests are failing, I'd guess you have a SQL query error occurring which is invalidating the txn. Could you also add a functional test for the clone route?

dLobatog · 2014-07-16T09:40:56Z

app/controllers/config_templates_controller.rb

    @config_template = ConfigTemplate.new
  end

+  def clone
+    @clone = @config_template.clone
+    @config_template = @clone


@clone seems unnecessary here, @config_template = @config_template.clone would work too.

I took this verbatim from the existing clone methods in other models. I assumed they did this for a reason, but you're right that should work.

GregSutcliffe · 2014-07-16T10:05:53Z

Overall +1, I think marking our default templates as read-only is fine (we can disable editing, but still perhaps allow complete deletion if the user really doesn't care?)

I'd suggest a boolean flag for distributor templates vs user templates, and then the distributor ones could be shown differently in the index, perhaps a separate tab or graying out of lines? Clicking on 5 templates trying to find one you can edit isn't helpful...

stbenjam · 2014-07-16T10:10:13Z

@GregSutcliffe A tab looks like it won't be too simple to implement, maybe a column?

A user can also search "editable = True" if we enable the field for search.

ohadlevy · 2014-07-16T10:12:22Z

how about a generic lock option? (make the unlock a separate process?)

stbenjam · 2014-07-16T10:24:26Z

@ohadlevy I hadn't planned to make them user-unlockable, the reasoning is to support default templates that can be added to multiple orgs. We don't want a user in Org A to be able to edit "Kickstart default RHEL" and affect a user in Org B. They'll have to clone to customize. But we want both Org A and Org B to see all the default templates. Then when a user creates Org C, Katello will assign all the templates that have this 'distributor' flag that @GregSutcliffe mentioned to that org too.

I also didn't plan to change Foreman's way of doing things, because locking the default templates breaks users who have edited them already, and people who use the community-templates plug-in.

Do you still want the ability to lock/unlock them in the UI by an admin? I think we'd end up having to remove that in Katello, we want to be able to always control the default templates.

ohadlevy · 2014-07-16T10:34:33Z

app/controllers/config_templates_controller.rb

@@ -24,6 +34,7 @@ def create
  end

  def edit
+    load_vars_for_ajax


Hmm.. what is the reason why need this ? AFAIR we dont have any ajax in the template editor?

When we load the new form, the associations aren't saved in the database so we have to store them in variables like @OperatingSystems, @oraganizations, @Locations. It's not ajax here, but it's how it's named for the similar feature in other models.

ohadlevy · 2014-07-16T10:35:59Z

bundler.d/assets.rb

@@ -3,7 +3,7 @@
  gem 'uglifier', '>= 1.0.3'
  gem 'execjs', '< 2.1.0'
  gem "jquery-rails", "2.0.3"
-  gem 'jquery-ui-rails'
+  gem 'jquery-ui-rails', '< 5.0.0'


just out of curiosity, why?

Because of #1564 ,which is fixed now. I'll remove this here.

GregSutcliffe · 2014-07-16T11:46:04Z

@stbenjam i'm concerned about minimizing where katello diverges from core, where possible. I don't think we consume templates that differently, so I'd rather design a good workflow now, than end up in another mess later.

I think templates need to be unlockable, but with a big disclaimer about how that means the user won't get updates to that template in future releases. Give power to the user, don't lock them in. At upgrade time, you can then update Templates.where(matching name && locked). Would that be sufficient for Katello too?

re: my earlier point, I'm less concerned about how it looks, whatever works for you, so long as we can visually tell on the index whats editable and what isn't.

stbenjam · 2014-07-16T14:30:20Z

Ok just pushed the latest iteration, taking @ohadlevy's locked suggestion. I like the usage workflow better.

@GregSutcliffe , I added an icon to indicate locked -- what do you think? We need different icons but just an example. Maybe one for unlocked too?

By default, only an admin can lock/unlock templates. I like this because then a company can provide all the organizations a set of "standard" templates for them to use, not just the ones provided by us.

ohadlevy · 2014-07-16T14:34:01Z

app/views/config_templates/index.html.erb

@@ -18,13 +18,16 @@
  </tr>
  <% for config_template in @config_templates %>
    <tr>
-      <td><%= link_to_if_authorized h(config_template), hash_for_edit_config_template_path(:id => config_template.to_param).merge(:auth_object => config_template, :authorizer => authorizer, :permission => 'edit_templates') %></td>
+      <td>  <%= image_tag("locked.png") if config_template.locked? %>


use the lock icon we already have --> http://getbootstrap.com/components/

GregSutcliffe · 2014-07-16T15:11:39Z

@stbenjam Looks good, will have to do a proper code reviwe soonish. I agree with your reasons for admin only, but there's no reason not to have a permission admins can grant if they wish - just don't enable it on any roles by default ;)

No need for an unlocked icon, that will clutter and make it hard to differentiate at speed.

stbenjam · 2014-07-16T15:18:03Z

@GregSutcliffe @ohadlevy @elobato Cool, thanks for all the feedback so far. I think this is better than the first iteration.

Demo of what it looks like:

stbenjam · 2014-07-16T16:38:31Z

Last change for now. Templates which are seeded (by a plug-in for example) may set the 'default' field and lock their templates. These may not be unlocked, and we're able to let the user know why because the seeder may opt to say who the vendor is for the templates.

dLobatog · 2014-07-17T07:03:08Z

app/models/config_template.rb

  validates :name, :presence => true, :uniqueness => true
  validates :name, :template, :presence => true
  validates :template_kind_id, :presence => true, :unless => Proc.new {|t| t.snippet }
+  validate :changes_when_template_is_locked


validate :changes, :if => lambda { |template| template.locked? || template.locked_changed? }

And remove the early return on changes_when_template_is_locked.

…f templates

dLobatog · 2014-07-17T14:07:20Z

Merged as 4a28771 , thank you @stbenjam !

dLobatog reviewed Jul 4, 2014
View reviewed changes

dLobatog added Needs re-review and removed Not yet reviewed labels Jul 4, 2014

stbenjam changed the title ~~fixes #1646 - enable cloning of templates~~ fixes #1646, #3103 - enable cloning for templates, and add read-only options Jul 5, 2014

jlsherrill reviewed Jul 7, 2014
View reviewed changes

domcleal reviewed Jul 8, 2014
View reviewed changes

domcleal added Waiting on contributor and removed Needs re-review labels Jul 8, 2014

domcleal removed the Needs re-review label Jul 8, 2014

dLobatog reviewed Jul 16, 2014
View reviewed changes

ohadlevy reviewed Jul 16, 2014
View reviewed changes

dLobatog reviewed Jul 17, 2014
View reviewed changes

fixes theforeman#1646, theforeman#3103 - enable cloning and locking o…

337a39c

…f templates

stbenjam mentioned this pull request Jul 17, 2014

fixes #4734 - make katello templates available in all taxonomies Katello/katello#4450

Merged

dLobatog added Ready to merge and removed Waiting on contributor labels Jul 17, 2014

dLobatog closed this Jul 17, 2014

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fixes #1646, #3103 - enable cloning for templates, and add read-only options #1559

fixes #1646, #3103 - enable cloning for templates, and add read-only options #1559

stbenjam commented Jul 3, 2014

dLobatog Jul 4, 2014

jlsherrill Jul 7, 2014

stbenjam Jul 7, 2014

jlsherrill Jul 7, 2014

domcleal Jul 8, 2014

jlsherrill commented Jul 7, 2014

stbenjam commented Jul 7, 2014

jlsherrill commented Jul 7, 2014

domcleal Jul 8, 2014

domcleal commented Jul 8, 2014

dLobatog Jul 16, 2014

stbenjam Jul 16, 2014

GregSutcliffe commented Jul 16, 2014

stbenjam commented Jul 16, 2014

ohadlevy commented Jul 16, 2014

stbenjam commented Jul 16, 2014

ohadlevy Jul 16, 2014

stbenjam Jul 16, 2014

ohadlevy Jul 16, 2014

stbenjam Jul 16, 2014

GregSutcliffe commented Jul 16, 2014

stbenjam commented Jul 16, 2014

ohadlevy Jul 16, 2014

GregSutcliffe commented Jul 16, 2014

stbenjam commented Jul 16, 2014

stbenjam commented Jul 16, 2014

dLobatog Jul 17, 2014

dLobatog commented Jul 17, 2014

fixes #1646, #3103 - enable cloning for templates, and add read-only options #1559

fixes #1646, #3103 - enable cloning for templates, and add read-only options #1559

Conversation

stbenjam commented Jul 3, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jlsherrill commented Jul 7, 2014

stbenjam commented Jul 7, 2014

jlsherrill commented Jul 7, 2014

Choose a reason for hiding this comment

domcleal commented Jul 8, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GregSutcliffe commented Jul 16, 2014

stbenjam commented Jul 16, 2014

ohadlevy commented Jul 16, 2014

stbenjam commented Jul 16, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GregSutcliffe commented Jul 16, 2014

stbenjam commented Jul 16, 2014

Choose a reason for hiding this comment

GregSutcliffe commented Jul 16, 2014

stbenjam commented Jul 16, 2014

stbenjam commented Jul 16, 2014

Choose a reason for hiding this comment

dLobatog commented Jul 17, 2014