Launch an URL returned by an automate button #10118

martinpovolny · 2016-07-28T13:15:29Z

https://bugzilla.redhat.com/show_bug.cgi?id=1399368

Purpose or Intent

Extension to custom buttons where:

the custom button runs an automate method through the queue (using MiqTask)
the customer-provided automate method stuff would do some potentially complex stuff and would return an URL (through SystemConsole model).
the UI opens browser window on that URL ~~or even open a HTML5 VNC client to a provided websocket URL (not in this PR)~~.

A simple usecase is opening a custom web page that is not available immediately, but needs to be made ready by the automate script.

The greater idea is than an automate script would somehow build a chain of proxy servers for VNC connection and the ManageIQ UI would open a HTML5 VNC client that would connect through that tunnel.

Example usage from automate:

create a custom button with the check box "Open URL" checked
attach a method to it with the text below:

  $evm.root['vm'].remote_console_url = 'http://www.redhat.com'

press the button.

FIXME (for a follow up PR?)

When deleting from SystemConsole we might need to do some cleanups (websocket proxy) or 2nd level proxy (Console proxy level 2 #11273). However it makes no sense to use the proxies together with this on a single VM so this is not a big issue.
Might need to review how user is passed through and what can be set by the set_remote_console_url method exposed to automate.

gmcculloug · 2016-07-28T22:59:29Z

We do something like this for the Dynamic dialog fields in automate. We run an automate resolution and get a workspace back app/models/dynamic_dialog_field_value_processor.rb#L8. Then pass the root attributes app/models/dynamic_dialog_field_value_processor.rb#L14 to be processed here app/models/dialog_field_text_box.rb#L61.

Does that help?

martinpovolny · 2016-07-29T05:27:59Z

@gmcculloug : If I read it correctly, then that is sync. I need to do it async through the MiqTask (and wait_for_task on the UI side).

Things like setting up a tunnel might take some time and the UI should not hang while waiting for the automate.

Also the setup of a tunnel to a VNC endpoint on a hypevisor node would be done by a different appliance. The UI appliance probably won't be able to reach the hypervisor nodes directly at a service provider deployment.

Does that make sense?

gmcculloug · 2016-08-01T19:28:45Z

@martinpovolny I think what you really want to do here is pass something to the automate method that it can update instead of trying to pull back data from the automate method.

For example you could pass the ID of the resource you are running against and if that supports custom_attributes the automate script could set the required data there. Otherwise, we could do something like expose the MiqTask object to the automate service model and allow the automate method to set values into the Task.

gmcculloug · 2016-09-12T14:20:06Z

lib/miq_automation_engine/service_models/miq_ae_service_vm_infra.rb

@@ -1,4 +1,6 @@
 module MiqAeMethodService
  class MiqAeServiceVmInfra < MiqAeServiceVm
+    expose :set_remote_console_url


Based on the active record model method this belongs in miq_ae_service_vm.rb. (Should be removed from miq_ae_service_vm_infra.rb and miq_ae_service_vm_or_template.rb.

mkanoor · 2016-10-18T18:52:20Z

app/controllers/application_controller/buttons.rb

@@ -250,6 +251,17 @@ def applies_to_class_model(applies_to_class)
    applies_to_class == "ServiceTemplate" ? Service : applies_to_class.constantize
  end

+  def custom_button_done
+    url = SystemConsole.where(:vm => params[:id]).first.try(:url)


@martinpovolny @gmcculloug
Is this meant only for VM's or can it be used with other objects like storage, network, host etc.

only VMs at this point.

@martinpovolny
Will we have a 'ur'l as a custom attribute available for vm objects which the Automate Method would set?

@mkanoor : that sounds good. How do I do that? @gmcculloug suggested that I should pass an ID of some resource and work with that. Can you show me how I would do what you suggest?

Change to: url = SystemConsole.find_by(:vm => params[:id]).try(:url)

You are currently setting the url when calling set_remote_console_url from automate. Do you need to store the url somewhere else since it already resides in the SystemConsole instance associated to the VM?

If so automate supports custom_get and custom_set methods. lib/miq_automation_engine/service_models/miq_ae_service_vm_or_template.rb#L140

Note: These custom attributes are visible in the VM summary screen. Here is an example of what it would look like to set a custom attribute named url:

skateman · 2016-10-23T20:00:06Z

@martinpovolny I'm getting this error in the automate.log:

[----] E, [2016-10-23T21:58:05.450688 #24350:2b16aae6f550] ERROR -- : MiqAeServiceModelBase.ar_method raised: <ActiveRecord::RecordInvalid>: <Validation failed: Url secret has already been taken>
[----] E, [2016-10-23T21:58:05.450768 #24350:2b16aae6f550] ERROR -- : /home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/validations.rb:78:in `raise_validation_error'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/validations.rb:50:in `save!'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/attribute_methods/dirty.rb:30:in `save!'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/transactions.rb:324:in `block in save!'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/transactions.rb:395:in `block in with_transaction_returning_status'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/connection_adapters/abstract/database_statements.rb:232:in `block in transaction'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/connection_adapters/abstract/transaction.rb:189:in `within_new_transaction'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/connection_adapters/abstract/database_statements.rb:232:in `transaction'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/transactions.rb:211:in `transaction'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/transactions.rb:392:in `with_transaction_returning_status'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/transactions.rb:324:in `save!'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/suppressor.rb:45:in `save!'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/activerecord-5.0.0.1/lib/active_record/persistence.rb:51:in `create!'
/home/dhalasz/Repositories/ManageIQ/manageiq/app/models/vm.rb:97:in `set_remote_console_url'
/home/dhalasz/Repositories/ManageIQ/manageiq/lib/miq_automation_engine/engine/miq_ae_service_model_base.rb:269:in `public_send'
/home/dhalasz/Repositories/ManageIQ/manageiq/lib/miq_automation_engine/engine/miq_ae_service_model_base.rb:269:in `block in object_send'
/home/dhalasz/Repositories/ManageIQ/manageiq/lib/miq_automation_engine/engine/miq_ae_service_model_base.rb:288:in `ar_method'
/home/dhalasz/Repositories/ManageIQ/manageiq/lib/miq_automation_engine/engine/miq_ae_service_model_base.rb:298:in `ar_method'
/home/dhalasz/Repositories/ManageIQ/manageiq/lib/miq_automation_engine/engine/miq_ae_service_model_base.rb:267:in `object_send'
/home/dhalasz/Repositories/ManageIQ/manageiq/lib/miq_automation_engine/engine/miq_ae_service_model_base.rb:122:in `block (2 levels) in expose'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/2.3.0/drb/drb.rb:1624:in `perform_without_block'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/2.3.0/drb/drb.rb:1584:in `perform'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/2.3.0/drb/drb.rb:1657:in `block (2 levels) in main_loop'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/2.3.0/drb/drb.rb:1653:in `loop'
/home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/2.3.0/drb/drb.rb:1653:in `block in main_loop'
[----] E, [2016-10-23T21:58:05.455019 #24350:2b16ac1643a4] ERROR -- : <AEMethod openurl> The following error occurred during method evaluation:
[----] E, [2016-10-23T21:58:05.455498 #24350:2b16ac1643a4] ERROR -- : <AEMethod openurl>   DRb::DRbUnknownError: ActiveRecord
[----] E, [2016-10-23T21:58:05.456382 #24350:2b16ac1643a4] ERROR -- : <AEMethod openurl>   /home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/2.3.0/drb/drb.rb:1149:in `method_missing'
[----] E, [2016-10-23T21:58:05.459874 #24350:2b16ac1643a4] ERROR -- : Method STDERR: /home/dhalasz/.rbenv/versions/2.3.1/lib/ruby/2.3.0/drb/drb.rb:1149:in `method_missing': ActiveRecord (DRb::DRbUnknownError)
[----] E, [2016-10-23T21:58:05.460288 #24350:2b16ac1643a4] ERROR -- : Method STDERR:    from <code: $evm.root['vm'].set_remote_console_url(:url => 'http://www.seznam.cz', :userid => $evm.root['user_id'])>:5:in `<main>'
[----] I, [2016-10-23T21:58:05.465484 #24350:2b16aae5b104]  INFO -- : <AEMethod [/miq-Marketplace/System/Request/OpenURL]> Ending

martinpovolny · 2016-10-25T13:43:04Z

@skateman : can you, please, check again?

skateman · 2016-10-25T17:27:52Z

@martinpovolny looks good, aren't we planning to add a spinner while we wait for the task?

martinpovolny · 2016-10-25T19:35:21Z

Would be good to get some feedback from the automate people.

I think that the functionality is a good one but I am not so sure about how I actually did it. It works but if feels hacky.

The question by @mkanoor if it's only valid for VMs suggests it might make sense for more entities. But the SystemConsole model is only related to VMs.

gmcculloug · 2016-11-02T17:05:14Z

lib/miq_automation_engine/service_models/miq_ae_service_vm.rb

@@ -1,5 +1,9 @@
 module MiqAeMethodService
  class MiqAeServiceVm < MiqAeServiceVmOrTemplate
+    def set_remote_console_url(url)


Following the rubocop warning this method should be named remote_console_url=
def remote_console_url=(url)

Would also need to update the method in the VM model which would need to take two parameters.

gmcculloug · 2016-11-02T17:07:04Z

app/models/vm.rb

@@ -91,4 +91,16 @@ def running_processes
    end
    pl
  end
+
+  def set_remote_console_url(url, user_id)


Should be renamed:
def remote_console_url=(url, user_id)

really? how would I call such method?

ok, I did. I don't know what magic happens here, a method with = with more that one arg sounds strange, but w/o the names matching I was getting errors

miq-bot · 2016-11-27T21:06:57Z

<github_pr_commenter_batch />Some comments on commits martinpovolny/manageiq@c9de5ff~...c02e8ea

spec/controllers/application_controller/buttons_spec.rb

⚠️ - 55 - Detected expect_any_instance_of. This RSpec method is highly discouraged, please only use when absolutely necessary.

miq-bot · 2016-11-27T21:07:56Z

Checked commits martinpovolny/manageiq@c9de5ff~...c02e8ea with ruby 2.2.5, rubocop 0.37.2, and haml-lint 0.16.1
8 files checked, 0 offenses detected
Everything looks good. 🏆

gmcculloug · 2016-11-28T20:43:28Z

Look goos, thanks.

simaishi · 2017-01-06T21:33:18Z

Euwe backport conflict:

$ git cherry-pick -e -x -m 1 6502d59
error: could not apply 6502d59... Merge pull request #10118 from martinpovolny/button_launch_url

$ git diff
diff --cc app/controllers/application_controller/buttons.rb
index cf250b6,54095da..0000000
--- a/app/controllers/application_controller/buttons.rb
+++ b/app/controllers/application_controller/buttons.rb
@@@ -264,12 -276,15 +276,19 @@@ module ApplicationController::Button
        options[:target_id] = obj.id
        options[:target_kls] = obj.class.name
        dialog_initialize(button.resource_action, options)
+     elsif button.options && button.options.key?(:open_url) && button.options[:open_url]
+       task_id = button.invoke_async(obj)
+       initiate_wait_for_task(:task_id => task_id, :action => :custom_button_done)
      else
        begin
++<<<<<<< HEAD
 +        button.invoke(obj)    # Run the task
++=======
+         button.invoke(obj)
++>>>>>>> 6502d59... Merge pull request #10118 from martinpovolny/button_launch_url
        rescue StandardError => bang
          add_flash(_("Error executing: \"%{task_description}\" %{error_message}") %
-           {:task_description => params[:desc], :error_message => bang.message}, :error) # Push msg and error flag
+           {:task_description => params[:desc], :error_message => bang.message}, :error)
        else
          add_flash(_("\"%{task_description}\" was executed") % {:task_description => params[:desc]})
        end

simaishi · 2017-01-06T21:33:31Z

@martinpovolny Please resolve conflict and make Euwe-specific PR (referencing this one) or suggest other PRs to backport.

simaishi · 2017-01-12T02:05:58Z

Backported to Euwe via #13449

martinpovolny added enhancement ui labels Jul 28, 2016

chessbyte added the wip label Jul 28, 2016

chessbyte assigned mkanoor Jul 28, 2016

martinpovolny force-pushed the button_launch_url branch from 0595035 to 2cbfb4a Compare September 12, 2016 14:04

gmcculloug reviewed Sep 12, 2016
View reviewed changes

martinpovolny force-pushed the button_launch_url branch 2 times, most recently from fb6c3f3 to 1f54960 Compare September 22, 2016 11:28

martinpovolny removed the wip label Sep 22, 2016

martinpovolny changed the title ~~[WIP] Launch an URL returned by an automate button~~ Launch an URL returned by an automate button Sep 22, 2016

martinpovolny changed the title ~~Launch an URL returned by an automate button~~ [WIP] Launch an URL returned by an automate button Sep 22, 2016

martinpovolny added the wip label Sep 22, 2016

martinpovolny mentioned this pull request Sep 23, 2016

wait_for_task action #11485

Merged

martinpovolny force-pushed the button_launch_url branch 2 times, most recently from d468d52 to a68a360 Compare October 17, 2016 12:14

martinpovolny changed the title ~~[WIP] Launch an URL returned by an automate button~~ Launch an URL returned by an automate button Oct 17, 2016

martinpovolny force-pushed the button_launch_url branch 2 times, most recently from 79996a9 to f966f96 Compare October 17, 2016 19:08

martinpovolny removed the wip label Oct 17, 2016

mkanoor reviewed Oct 18, 2016

View reviewed changes

martinpovolny added the euwe/yes label Oct 21, 2016

martinpovolny force-pushed the button_launch_url branch from f966f96 to 36fc0fd Compare October 25, 2016 12:25

mkanoor assigned gmcculloug Oct 25, 2016

gmcculloug reviewed Nov 2, 2016

View reviewed changes

martinpovolny added 8 commits November 27, 2016 20:24

Open URLs through custom buttons and automate.

c9de5ff

Add option 'Open URL' to custom buttons.

3da17c7

CustomButtons: use new option :open_url when button is pressed.

847e606

Automate button launch url: Rubocop fixes.

5f31dcf

Automate button launch url: add a spec.

5c5ec38

SystemConsole: add required url_secret.

5a9a373

SystemConsole: replace where.first with find_by.

f8028ae

SystemConsole: set_remote_console_url has only one param: url.

7f27d6e

martinpovolny force-pushed the button_launch_url branch from 45da3f4 to 8207958 Compare November 27, 2016 19:45

SystemConsole: rename set_remote_console_url to remote_console_url=.

c02e8ea

martinpovolny force-pushed the button_launch_url branch from 8207958 to c02e8ea Compare November 27, 2016 21:03

gmcculloug merged commit 6502d59 into ManageIQ:master Nov 28, 2016

gmcculloug added this to the Sprint 50 Ending Dec 5, 2016 milestone Nov 28, 2016

dclarizio added the blocker label Nov 28, 2016

simaishi removed the blocker label Nov 29, 2016

h-kataria mentioned this pull request Dec 5, 2016

Fixed code that sets values of button_image, display & open_url fields #13001

Merged

simaishi added the euwe/conflict label Jan 6, 2017

This was referenced Jan 11, 2017

[Euwe] Launch an URL returned by an automate button #13448

Closed

[EUWE] Launch an URL returned by an automate button #13449

Merged

simaishi added euwe/backported and removed euwe/conflict labels Jan 12, 2017

martinpovolny deleted the button_launch_url branch November 28, 2017 18:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Launch an URL returned by an automate button #10118

Launch an URL returned by an automate button #10118

martinpovolny commented Jul 28, 2016 •

edited by dclarizio

Loading

gmcculloug commented Jul 28, 2016

martinpovolny commented Jul 29, 2016

gmcculloug commented Aug 1, 2016

gmcculloug Sep 12, 2016

mkanoor Oct 18, 2016

martinpovolny Oct 19, 2016

mkanoor Oct 25, 2016

martinpovolny Oct 25, 2016

gmcculloug Oct 26, 2016

skateman commented Oct 23, 2016

martinpovolny commented Oct 25, 2016

skateman commented Oct 25, 2016

martinpovolny commented Oct 25, 2016

gmcculloug Nov 2, 2016

martinpovolny Nov 27, 2016

gmcculloug Nov 2, 2016

martinpovolny Nov 27, 2016

martinpovolny Nov 27, 2016

miq-bot commented Nov 27, 2016

miq-bot commented Nov 27, 2016

gmcculloug commented Nov 28, 2016

simaishi commented Jan 6, 2017

simaishi commented Jan 6, 2017

simaishi commented Jan 12, 2017

Launch an URL returned by an automate button #10118

Launch an URL returned by an automate button #10118

Conversation

martinpovolny commented Jul 28, 2016 • edited by dclarizio Loading

Purpose or Intent

FIXME (for a follow up PR?)

gmcculloug commented Jul 28, 2016

martinpovolny commented Jul 29, 2016

gmcculloug commented Aug 1, 2016

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

Choose a reason for hiding this comment

skateman commented Oct 23, 2016

martinpovolny commented Oct 25, 2016

skateman commented Oct 25, 2016

martinpovolny commented Oct 25, 2016

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

miq-bot commented Nov 27, 2016

miq-bot commented Nov 27, 2016

gmcculloug commented Nov 28, 2016

simaishi commented Jan 6, 2017

simaishi commented Jan 6, 2017

simaishi commented Jan 12, 2017

martinpovolny commented Jul 28, 2016 •

edited by dclarizio

Loading