libyui_client 0.4.0

data/lib/libyui_client/widgets/base.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    class Base
+      include Waitable
+
+      def initialize(widget_controller, filter)
+        @widget_controller = widget_controller
+        @filter = filter
+      end
+
+      # Allows to check if widget exists on the current screen or not.
+      # Can be called against any widget.
+      # @return [Boolean] true if widget exists, false otherwise.
+      # @example Check if button with id 'test' exists
+      #   app.button(id: 'test').exists? # true
+      def exists?
+        LibyuiClient.logger.info("Checking if #{class_name} with #{@filter} exists")
+        find_widgets
+        LibyuiClient.logger.info("#{class_name} exists: #{@filter}")
+        true
+      rescue Error::WidgetNotFoundError
+        LibyuiClient.logger.info("#{class_name} does not exist: #{@filter}")
+        false
+      end
+
+      # Allows to check if widget enabled or disabled.
+      # Can be called against any widget. Widget that does not have "enabled" property is counted as enabled.
+      # @return [Boolean] true if widget enabled, false otherwise.
+      # @example Check if button with id 'test' enabled
+      #   app.button(id: 'test').enabled? # true
+      def enabled?
+        enabled_prop = property(:enabled)
+        enabled_prop.nil? || enabled_prop == true
+      end
+
+      # Returns debug_label value for widget.
+      # Can be called against any widget.
+      # @return [String] value of debug_label property
+      # @example Get debug_label value for button
+      #   {
+      #     "class": "YQWizardButton",
+      #     "debug_label": "Cancel",
+      #     "fkey": 9,
+      #     "id": "cancel",
+      #     "label": "&Cancel"
+      #   }
+      # @example
+      #   debug_label = app.button(id: 'cancel').debug_label # Cancel
+      def debug_label
+        property(:debug_label)
+      end
+
+      # Returns value of widget property.
+      # This method can be used to retrieve value of some specific property,
+      # but widget does not have a method to return the value.
+      # Can be called against any widget.
+      # @param property [Symbol] symbolic name of the property to get value for.
+      # @return [Object] value for property of a widget
+      # @example Get value of "label" property for button with id "test"
+      #   value = app.button(id: 'test').property(:label)
+      def property(property)
+        LibyuiClient.logger.info("Get #{property} for #{class_name} #{@filter}")
+        result = find_widgets.first[property.to_sym]
+        LibyuiClient.logger.info("Found '#{property}=#{result}' for #{class_name} #{@filter}")
+        result
+      end
+
+      # This method can be used to send any action to widget.
+      # Can be called against any widget.
+      # @param params [Hash] actions to be sent (e.g. action: 'press').
+      # @example Send action 'press' to button widget.
+      #   app.button(id: 'test').action(action: 'press')
+      def action(params)
+        unless @filter.regex.empty?
+          widget = find_widgets.first
+          @filter = FilterExtractor.new(widget)
+        end
+        LibyuiClient.logger.info("Send #{params} action for #{class_name} #{@filter}")
+        @widget_controller.send_action(@filter.plain, params)
+      end
+
+      # Get all widgets found with filter.
+      # The method is mainly introduced for "class" filter, which can return an array of widgets.
+      # It only makes sense to use this method whenever server side filters allow to find individually those
+      # collected widgets, otherwise those will not be able to access their internal properties.
+      # @return [Array] array of deserialized widgets.
+      # Then actions that are specified for the widget can be called while iterating over the returned array.
+      # @example Get all checkboxes and check all of them
+      #   checkboxes = app.checkbox(class: "YCheckBox").collect_all
+      #   checkboxes.each{ |checkbox| puts checkbox.check }
+      def collect_all
+        LibyuiClient.logger.info("Collect all #{class_name} widgets with filter #{@filter}")
+        widgets = find_widgets
+        LibyuiClient.logger.info("Found widgets for filter #{@filter}: #{widgets}")
+        widgets.map do |widget|
+          self.class.new(@widget_controller, FilterExtractor.new(widget))
+        end
+      end
+
+      private
+
+      def class_name
+        self.class.name.split('::').last
+      end
+
+      def find_widgets
+        LibyuiClient.logger.info("Search for #{class_name} #{@filter}")
+        @widget_controller.find(@filter.plain).body(regex_filter: @filter.regex)
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/button.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a button in UI. It can be YQWizardButton, YPushButton.
+    class Button < Widgets::Base
+      # Sends action to click the button in UI.
+      # @return [Button] in case action is successful
+      # @example Click button with id 'test'
+      #   app.button(id: 'test').click
+      def click
+        action(action: Actions::PRESS)
+        self
+      end
+
+      # Returns fkey value for the button.
+      # @return [Integer] F (function) key that can be used as shortcut to press the button.
+      # @example Get fkey value for YQWizardButton
+      #   {
+      #     "class": "YQWizardButton",
+      #     "debug_label": "Cancel",
+      #     "fkey": 9,
+      #     "id": "cancel",
+      #     "label": "&Cancel"
+      #   }
+      # @example
+      #   fkey = app.button(id: 'cancel').fkey
+      def fkey
+        property(:fkey)
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/checkbox.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a Checkbox in UI. It can be YCheckBox or YCheckBoxFrame.
+    class Checkbox < Widgets::Base
+      # Sends action to explicitly check the checkbox in UI (regardless of the current state).
+      # @return [Checkbox] in case action is successful
+      # @example Check checkbox with id 'test'
+      #   app.checkbox(id: 'test').check
+      def check
+        action(action: Actions::CHECK)
+        self
+      end
+
+      # Returns the state of checkbox (checked/unchecked).
+      # Gets value from 'value' parameter in JSON representation of YCheckBox or YCheckBoxFrame.
+      # @return [Boolean] true if it is checked, false otherwise.
+      # @example Get checkbox state
+      #   {
+      #     "class": "YCheckBox",
+      #     "debug_label": "Change the Time Now",
+      #     "id": "change_now",
+      #     "label": "Chan&ge the Time Now",
+      #     "notify": true,
+      #     "value": true
+      #   }
+      # @example
+      #   app.checkbox(id: 'change_now').checked? # true
+      def checked?
+        property(:value)
+      end
+
+      # Sends action to toggle the checkbox in UI (i.e. uncheck when checked, or check otherwise).
+      # @return [Checkbox] in case action is successful
+      # @example Toggle checkbox with id 'test'
+      #   app.checkbox(id: 'test').toggle
+      def toggle
+        action(action: Actions::TOGGLE)
+        self
+      end
+
+      # Sends action to explicitly uncheck the checkbox in UI (regardless of the current state).
+      # @return [Checkbox] in case action is successful
+      # @example Uncheck checkbox with id 'test'
+      #   checkbox(id: 'test').uncheck
+      def uncheck
+        action(action: Actions::UNCHECK)
+        self
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/combobox.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a ComboBox in the UI. It can be YComboBox.
+    class Combobox < Widgets::Base
+      # Returns the list of items available to select from combobox.
+      # @return [Array<String>] array of strings.
+      # @example Get items from combobox with id "nfs_version"
+      #   {
+      #     "class": "YComboBox",
+      #     "debug_label": "NFS Version",
+      #     "icon_base_path": "",
+      #     "id": "nfs_version",
+      #     "items": [
+      #       {
+      #         "label": "Any (Highest Available)",
+      #         "selected": true
+      #       },
+      #       {
+      #         "label": "Force NFSv3"
+      #       }
+      #     ],
+      #     "items_count": 5,
+      #     "label": "NFS &Version",
+      #     "value": "Any (Highest Available)"
+      #   }
+      # @example
+      #   app.combobox(id: 'nfs_version').items
+      #   # Any (Highest Available)
+      #   # Force NFSv3
+      def items
+        property(:items).map { |x| x[:label] }
+      end
+
+      # Sends action to select the item in combobox.
+      # @param item [String] item to select in combobox.
+      # List of items can be retrieved from JSON "items"->"label" manually or by using 'combobox(filter).items'.
+      # @return [Combobox] in case action is successful
+      # @raise LibyuiClient::Error::ItemNotFoundInWidgetError in case value is not found in combobox.
+      # @example Select "Force NFSv3" item in combobox with id "nfs_version"
+      #   app.combobox(id: 'nfs_version').select('Force NFSv3')
+      def select(item)
+        action(action: Actions::SELECT, value: item)
+        self
+      end
+
+      # Returns selected item in combobox.
+      # @example Get selected item in combobox with id "nfs_version"
+      #   {
+      #     "class": "YComboBox",
+      #     "debug_label": "NFS Version",
+      #     "icon_base_path": "",
+      #     "id": "nfs_version",
+      #     "items": [
+      #       {
+      #         "label": "Any (Highest Available)",
+      #         "selected": true
+      #       },
+      #       {
+      #         "label": "Force NFSv3"
+      #       }
+      #     ],
+      #     "items_count": 5,
+      #     "label": "NFS &Version",
+      #     "value": "Any (Highest Available)"
+      #   }
+      # @example
+      #   app.combobox(id: 'nfs_version').value
+      def value
+        property(:value)
+      end
+
+      # Sends action to set string to the editable combobox.
+      # @param item [String] value to set in the combobox.
+      # To check if combobox is editable, call editable?
+      # @return [Combobox] in case action is successful
+      # @raise LibyuiClient::Error::ItemNotFoundInWidgetError in case value is not found in combobox.
+      # @example Set "Custom Version" item in combobox with id "nfs_version"
+      #   app.combobox(id: 'nfs_version').select('Custom Version')
+      def set(value)
+        action(action: Actions::ENTER_TEXT, value: value)
+        self
+      end
+
+      # Allows to check if combobox is editable and allows setting .
+      # @return [Boolean] true if widget enabled, false otherwise.
+      # @example Check if combobox with id 'test' editable
+      #   app.combobox(id: 'test').editable? # true
+      def editable?
+        property(:editable) == true
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/datefield.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a date field in the UI, namely YDateField.
+    class Datefield < Widgets::Base
+      # Sends action to set the value of date field. Accepts Date, Time or DateTime
+      # object and sets value in ISO 8601 format YYYY-MM-DD.
+      # @param date [Date] date to be set in date field
+      # @return [Datefield] in case action is successful
+      # @raise LibyuiClientError if parameter is not Date, DateTime or Time
+      # @example Set date in date field with id 'test' to current date
+      #   app.datefield(id: 'date').set(Time.now)
+      # @example Set date in date field with id 'test' to 2002-12-29
+      #   app.datefield(id: 'date').set(DateTime.new(2002,12,29))
+      # @example Set date in date field with id 'test' to 2021-02-03
+      #   app.datefield(id: 'date').set(Date.new(2001,2,3))
+      def set(date)
+        unless  [Date, DateTime, Time].any? { |c| date.is_a? c }
+          raise Error::LibyuiClientError, 'Parameter is not Date, Time or DateTime'
+        end
+
+        action(action: Actions::ENTER_TEXT, value: date.strftime('%F'))
+        self
+      end
+
+      # Returns text that is currently set for datefield.
+      # Gets value from 'value' parameter in JSON representation of YDateField.
+      # @return [String] value
+      # @example Get value from datefield with id "date"
+      #   {
+      #       "class" : "YDateField",
+      #       "debug_label" : "Date:",
+      #       "hstretch" : true,
+      #       "id" : "date",
+      #       "label" : "&Date:",
+      #       "notify" : true,
+      #       "value" : "1989-11-09"
+      #   }
+      # @example
+      #   app.datefield(id: 'date').value # '1989-11-09'
+      def value
+        property(:value)
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/label.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a Label UI. It can be YLabel, YLabel_Heading
+    class Label < Widgets::Base
+      # Returns if label is a heading being represented in bold in the UI
+      # Gets value from 'is_heading' parameter in JSON representation of YLabel_Heading.
+      # @return [Boolean] true if it is a heading, false otherwise.
+      # @example Check label with 'label' "Product name"
+      #   {
+      #     "class": "YLabel_Heading",
+      #     "debug_label": "Product name ...",
+      #     "is_heading": true,
+      #     "label": "Product name",
+      #     "text": "Product name"
+      #   }
+      # @example
+      #   app.label(label: 'Product name').heading? # true
+      def heading?
+        heading_prop = property(:is_heading)
+        !heading_prop.nil? && heading_prop == true
+      end
+
+      # Returns text value for the label.
+      # @return [String] value
+      # @example Get text value for YLabel, YLabelHeading
+      #   {
+      #     "class": "YLabel",
+      #     "debug_label": "short message",
+      #     "label": "test label",
+      #     "text": "text label"
+      #   }
+      # @example
+      #   text = app.label(label: 'test label').text # "text label"
+      def text
+        property(:text)
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/menubutton.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a menubutton in UI. It can be YMenuButton.
+    class Menubutton < Widgets::Base
+      # Sends action to click on one of the items of the menubutton in UI.
+      # @param item [String] value to select from items.
+      # @example Click button with label 'test_button' for menubutton with id 'test_id'.
+      # @example
+      #   app.menubutton(id: 'test_id').click('test_button')
+      def click(item)
+        action(action: Actions::PRESS, value: item)
+      end
+
+      # Returns the list of items available to select from widget.
+      # @return [Array<String>] array of strings.
+      # @example Get items from widget with id "test_id"
+      #   {
+      #     "class": "YMenuButton",
+      #     "debug_label": "test",
+      #     "icon_base_path": "",
+      #     "id": "test_id",
+      #     "items": [
+      #       {
+      #         "label": "button1"
+      #       },
+      #       {
+      #         "label": "button2"
+      #       },
+      #       {
+      #         "label": "button3"
+      #       }
+      #     ],
+      #     "items_count": 3,
+      #     "label": "button group"
+      #   }
+      # @example
+      #   app.menubutton(id: 'test').items
+      #   # button1
+      #   # button2
+      #   # button3
+      def items
+        property(:items).map { |x| x[:label] }
+      end
+    end
+  end
+end

data/lib/libyui_client/widgets/multilinebox.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Widgets
+    # Class representing a multilinebox in the UI. It can be YMultiLineEdit.
+    class Multilinebox < Widgets::Base
+      # Returns maximum string length to set in the multilinebox
+      # @return [Integer] maximum number of character to set in the multilinebox
+      # @example Check maximum string length in multilinebox with id 'TEST_ID'
+      #   }
+      #      "class" : "YMultiLineEdit",
+      #      "debug_label" : "test_label",
+      #      "default_visible_lines" : 3,
+      #      "hstretch" : true,
+      #      "hweight" : 1,
+      #      "id" : "\"TEST_ID\"",
+      #      "input_max_length" : -1,
+      #      "label" : "test_label",
+      #      "value" : "",
+      #      "vstretch" : true
+      #   }
+      # @example
+      #   app.multilinebox(id: '"TEST_ID"').max_length
+      #     # -1
+      def max_length
+        property(:input_max_length)
+      end
+
+      # Returns the default visible number of lines for the multilinebox
+      # @return [Integer] default number of visible lines for the multilinebox
+      # @example Check the default visible number of line for  multilinebox with id 'TEST_ID'
+      #   }
+      #      "class" : "YMultiLineEdit",
+      #      "debug_label" : "test_label",
+      #      "default_visible_lines" : 3,
+      #      "hstretch" : true,
+      #      "hweight" : 1,
+      #      "id" : "\"TEST_ID\"",
+      #      "input_max_length" : -1,
+      #      "label" : "test_label",
+      #      "value" : "",
+      #      "vstretch" : true
+      #   }
+      # @example
+      #   app.multilinebox(id: '"TEST_ID"').visible_lines
+      #     # 3
+      def visible_lines
+        property(:default_visible_lines)
+      end
+
+      # Sends action to set the value of multilinebox.
+      # @param value [String] text to be set in multilinebox
+      # @return [Multilinebox] in case action is successful
+      # @example Set text in multilinebox with id 'TEST_ID' to 'text'
+      #   app.multilinebox(id: '"TEST_ID"').set("text\ntext in new line")
+      def set(value)
+        action(action: Actions::ENTER_TEXT, value: value)
+        self
+      end
+
+      # Returns text that is currently set for multilinebox.
+      # Gets value from 'value' parameter in JSON representation of YMultiLineEdit.
+      # @return [String] text set as value in the multilinebox.
+      # @example Get value from multilinebox with id "address"
+      #   }
+      #      "class" : "YMultiLineEdit",
+      #      "debug_label" : "test_label",
+      #      "default_visible_lines" : 3,
+      #      "hstretch" : true,
+      #      "hweight" : 1,
+      #      "id" : "\"TEST_ID\"",
+      #      "input_max_length" : -1,
+      #      "label" : "test_label",
+      #      "value" : "This is a \nmultiline\ntext",
+      #      "vstretch" : true
+      #   }
+      # @example
+      #   app.multilinebox(id: '"TEST_ID"').value # This is a \nmultiline\ntext
+      def value
+        property(:value)
+      end
+    end
+  end
+end