libyui_client 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53f5f7b922bad1e4f7dbc3d9cd05ac392dc45ffc64c422ad6edab4bcc5c86b64
+  data.tar.gz: 490036bf1243db80b41b77cd37ddf1eca0a4745b422b0290ee8ecf1c5e30bbb8
+SHA512:
+  metadata.gz: 46c6f9c9253371caeed56e60c3344a487ae241ed2dc4c8295b67a19c42b5b90c003c497efe01985c53e3cec5095e5a8c6619afe15971597f8225044dee8f9593
+  data.tar.gz: 2d7d984776851c6220f98109a7e176970788bec03eb609a2986c15266924486064edff6e5d5450620fccb44774dafb0f23e9ad75db1798013d259e854d34f3de

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+*.rbc
+.rakeTasks
+.rspec_status
+.vendor
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+doc/
+Gemfile.lock
+y2signal.log

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,41 @@
+# Cops documentation: https://rubocop.readthedocs.io/en/stable/
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Max: 120
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Metrics/ModuleLength:
+  Max: 500

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+before_install:
+  - gem install bundler
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in libyui_client.gemspec
+gemspec
+gem 'rubocop'
+gem 'webmock'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-2020 SUSE LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,210 @@
+# LibyuiClient
+
+Ruby gem to interact with YaST applications via libyui-rest-api.
+See documentation of the [libyui-rest-api project](https://github.com/libyui/libyui-rest-api/)
+for more details about server side implementation.
+
+Usage example:
+
+```ruby
+require 'libyui_client'
+
+app = LibyuiClient::App.new(host: 'localhost', port: '9999')
+button = app.button(id: 'settime')
+button.click
+```
+
+## Installing libyui_client
+
+As soon as the gem is in development, run the following command from command line:
+
+```
+gem "libyui_client", :git => "git@github.com:jknphy/libyui_client.git"
+```
+
+Now need to require gem in order to use it.
+
+## Initialize the app under control
+
+It is assumed the application is running on `localhost:9999`.
+Then the code to initialize the application looks like:
+
+```ruby
+require 'libyui_client'
+
+app = LibyuiClient::App.new(host: 'localhost', port: '9999')
+```
+
+## Supported widgets
+
+libyui_client supports different types of widgets.
+
+Here are examples of usage:
+
+### Button
+```ruby
+app.button(id: 'test_id').click  # clicks the button with id 'test_id'
+app.button(label: 'test_label').debug_label # get 'debug_label' value with label 'test_label'
+```
+
+### Bargraph
+```ruby
+# Get list of labels in the segments:
+app.bargraph(class: YBarGraph).labels
+# Get array of hashes containing label->value pairs denoting each segment:
+app.bargraph(class: YBarGraph).segments
+# Get list of values in the segments:
+app.bargraph(class: YBarGraph).values
+```
+
+### Checkbox
+```ruby
+app.checkbox(id: 'test_id').check  # checks the checkbox with id 'test_id'
+app.checkbox(label: 'test_label', class: 'YCheckBox').checked? # gets the state of checkbox with label 'test_label'
+app.checkbox(id: 'test_id').toggle # toggles the checkbox with id 'test_id'
+app.checkbox(label: 'test_label', class: 'YCheckBoxFrame').uncheck  # unchecks the checkbox with id 'test_id'
+```
+
+### Combobox
+```ruby
+app.combobox(id: 'test_id').items  # gets all available items for combobox with id 'test_id'
+app.combobox(id: 'test_id').select  # selects the checkbox with id 'test_id'
+app.combobox(id: 'test_id').selected_item # gets the selected item in combobox with id 'test_id'
+app.combobox(label: 'cmbx', class: 'YComboBox').set # Sets custom string to the editable checkbox
+```
+
+### Datefield
+```ruby
+# Set date field to 2048-08-16
+app.datefield(class: 'YDateField').set(Date.new(2048, 8, 16))
+app.datefield(id: 'date').value  # gets value from datefield with id 'date'
+```
+
+### Label
+```ruby
+app.label(id: 'test_id').heading?  # gets if label has bold font respresentation with id 'test_id'
+app.label(id: 'test_id').text  # gets text from label with id 'test_id'
+```
+
+### Menubutton
+```ruby
+app.menubutton(id: 'test_id').click('button1')  # clicks on 'button1' of menubutton with id 'test_id'
+```
+
+### Numberbox
+```ruby
+app.numberbox(id: 'test_id').min_value  # gets min value to be set in numberbox with id 'test_id'
+app.numberbox(id: 'test_id').max_value  # gets max value to be set in numberbox with id 'test_id'
+app.numberbox(id: 'test_id').set(99)  # sets 99 to numberbox with id 'test_id'
+app.numberbox(id: 'test_id').value  # gets value from numberbox with id 'test_id'
+```
+
+### Radiobutton
+```ruby
+app.radiobutton(id: 'test_id').select  # selects the radiobutton with id 'test_id'
+app.radiobutton(id: 'test_id').selected?  # gets the state of radiobutton with id 'test_id'
+```
+
+### Richtext
+```ruby
+app.richtext(id: 'test_id').click_link('test_link')  # clicks on link "test_link" with id 'test_id'
+app.richtext(id: 'test_id').text  # gets text from richtext
+```
+
+### Tab
+```ruby
+app.tab(id: 'test_id').items  # gets items from tab with id 'test_id'
+app.tab(id: 'test_id').select(value: 'item')  # selects specific tab with id 'test_id'
+app.tab(id: 'test_id').selected_item  # gets selected tab for tab with id 'test_id'
+```
+
+### Table
+```ruby
+# checks if there is not rows in table with id 'test_id':
+app.table(id: 'test_id').empty?
+# gets rows in the table with id 'test_id':
+app.table(id: 'test_id').items
+# selects row in table with value test.item.1 and column test.header:
+app.table(id: 'test_id').select( value: 'test.item.1', column: 'test.header' )
+# selects row with number 3, numeration starts from 0 and corresponds to the order
+# in the list returned by method `items`:
+app.table(id: 'test_id').select(row: 3)
+# gets items currently selected in table with id 'test_id':
+app.table(id: 'test_id').seleted_items
+
+
+```
+### Textbox
+```ruby
+app.textbox(id: 'test_id').max_length
+app.textbox(id: 'test_id').set('Test Text')  # sets "Test Text" to textbox with id 'test_id'
+app.textbox(id: 'test_id').password? # checks password mode for textbox with id 'test_id'
+app.textbox(id: 'test_id').valid_chars # checks valid chars for textbox with id 'test_id'
+app.textbox(id: 'test_id').value  # gets value from textbox with id 'test_id'
+```
+
+### TimeField
+```ruby
+# Set TimeField to current time
+app.timefield(label: 'time', class: 'YTimeField').set(Time.now)
+app.timefield(id: 'time').value  # gets value from timefield with id 'time'
+```
+
+### Tree
+```ruby
+app.tree(id: 'test_id').items  # gets items from tree with id 'test_id'
+app.tree(id: 'test_id').select('node1|node1_2')  # selects item in tree with id 'test_id'
+app.tree(id: 'test_id').selected_item  # gets currently highlighted item from tree with id 'test_id'
+```
+
+## Filters
+
+libyui_client supports the same filters, as libyui-rest-api provides:
+
+  * id - widget ID serialized as string, might include special characters like backtick (\`)
+  * label - widget label as currently displayed (i.e. translated!)
+  * class - widget class
+
+Also, regex for the filters is allowed.
+
+Example:
+```ruby
+app.button(id: /.*test/).debug_label
+```
+
+## Waits
+
+### Default timeout and interval
+
+All the actions against widgets in libyui_client are made with default timeout and interval.
+Default timeout is 5 sec, default interval is 0.5 sec.
+That means libyui_client will repeat sending requests to YaST application every 0.5 seconds until 5 seconds
+timeout will be reached. This default wait is needed because widgets may not be loaded immediately while trying to
+interact with them (e.g. when navigating from one screen to another).
+
+The default timeout and interval can be changed by the following:
+
+```ruby
+LibyuiClient.timeout = 10
+LibyuiClient.interval = 1
+```
+
+### Specific waits
+
+All the widgets include Waitable module, which contains special methods to allow explicit waiting:
+`wait_until` and `wait_while`.
+These methods can be used when it is needed to wait until some property of the widget will be changed.
+
+For example, wait until button will be enabled and click on it:
+
+```ruby
+# with #to_proc syntax:
+app.button(id: 'test_id').wait_until(&:enabled?).click
+
+# without #to_proc syntax:
+app.button(id: 'test_id').wait_until{ |button| button.enabled? }.click
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :integration do
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern = 'spec/widgets/*_spec.rb'
+  end
+end
+
+task :unit do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'libyui_client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/libyui_client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'json'
+require 'net/http'
+require 'uri'
+require 'timeout'
+require 'time'
+
+require 'libyui_client/version'
+require 'libyui_client/local_process'
+require 'libyui_client/widgets'
+require 'libyui_client/logger'
+require 'libyui_client/timer'
+require 'libyui_client/wait'
+require 'libyui_client/app'
+require 'libyui_client/http/http_client'
+require 'libyui_client/http/response'
+require 'libyui_client/http/version_controller'
+require 'libyui_client/http/widget_controller'
+require 'libyui_client/error'
+require 'libyui_client/actions'
+require 'libyui_client/filter_extractor'
+
+# Client to interact with YAST UI rest api framework for integration testing
+module LibyuiClient
+  class << self
+    attr_writer :timeout, :interval
+
+    def timeout
+      @timeout ||= 5
+    end
+
+    def interval
+      @interval ||= 0.5
+    end
+  end
+
+  def self.logger
+    @logger ||= LibyuiClient::Logger.new
+  end
+end

data/lib/libyui_client/actions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  module Actions
+    PRESS = 'press'
+    TOGGLE = 'toggle'
+    CHECK = 'check'
+    UNCHECK = 'uncheck'
+    SELECT = 'select'
+    ENTER_TEXT = 'enter_text'
+  end
+end

data/lib/libyui_client/app.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+module LibyuiClient
+  class App
+    # Used to initialize main entry point of LibyuiClient and set host and port
+    # for the application under control.
+    # @param host [String] host address (e.g. 'localhost', '192.168.0.1')
+    # @param port [String] port opened for communication (e.g. '9999')
+    def initialize(host:, port:)
+      @host = host
+      @port = port
+      @widget_controller = Http::WidgetController.new(host: host, port: port)
+      @version_controller = Http::VersionController.new(host: host, port: port)
+    end
+
+    # Initializes new instance of Bargraph with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Bargraph] new instance of Table
+    # @example
+    #   app.bargraph(id: 'id', label: 'label', class: 'YBarGraph')
+    def bargraph(filter)
+      Widgets::Bargraph.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Button with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Button] new instance of Button
+    # @example
+    #   app.button(id: 'id', label: 'label', class: 'YPushButton')
+    def button(filter)
+      Widgets::Button.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Checkbox with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Checkbox] new instance of Checkbox
+    # @example
+    #   app.checkbox(id: 'id', label: 'label', class: 'YCheckBox')
+    def checkbox(filter)
+      Widgets::Checkbox.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Combobox with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Combobox] new instance of Combobox
+    # @example
+    #   app.combobox(id: 'id', label: 'label', class: 'YComboBox')
+    def combobox(filter)
+      Widgets::Combobox.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Datefield with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Datefield] new instance of Datefield
+    # @example
+    #   app.datefield(id: 'id', label: 'label', class: 'YDateField')
+    def datefield(filter)
+      Widgets::Datefield.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Label with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Label] new instance of Label
+    # @example
+    #   app.label(id: 'id', label: 'label', class: 'YLabel')
+    def label(filter)
+      Widgets::Label.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Menubutton with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Menubutton] new instance of Menubutton
+    # @example
+    #   app.menubutton(id: 'id', label: 'label', class: 'YMenuButton')
+    def menubutton(filter)
+      Widgets::Menubutton.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Multilinebox with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Multilinebox] new instance of Multilinebox
+    # @example
+    #   app.multilinebox(id: 'id', label: 'label', class: 'YMultiLineEdit')
+    def multilinebox(filter)
+      Widgets::Multilinebox.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Numberbox with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Numberbox] new instance of Numberbox
+    # @example
+    #   app.numberbox(id: 'id', label: 'label', class: 'YIntField')
+    def numberbox(filter)
+      Widgets::Numberbox.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Progressbar with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Progressbar] new instance of Progressbar
+    # @example
+    #   app.progressbar(id: 'id', label: 'label', class: 'YProgressBar')
+    def progressbar(filter)
+      Widgets::Progressbar.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Radiobutton with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Radiobutton] new instance of Radiobutton
+    # @example
+    #   app.radiobutton(id: 'id', label: 'label', class: 'YRadioButton')
+    def radiobutton(filter)
+      Widgets::Radiobutton.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Richtext with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Richtext] new instance of Richtext
+    # @example
+    #   app.richtext(id: 'id', label: 'label', class: 'YRichText')
+    def richtext(filter)
+      Widgets::Richtext.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Selectionbox with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Selectionbox] new instance of Selectionbox
+    # @example
+    #   app.selectionbox(id: 'id', label: 'label', class: 'YSelectionBox')
+    def selectionbox(filter)
+      Widgets::Selectionbox.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Tab with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Tab] new instance of Tab
+    # @example
+    #   app.tab(id: 'id', label: 'label', class: 'YDumbTab')
+    def tab(filter)
+      Widgets::Tab.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Table with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Table] new instance of Table
+    # @example
+    #   app.table(id: 'id', label: 'label', class: 'YTable')
+    def table(filter)
+      Widgets::Table.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of time field with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Timefield] new instance of Table
+    # @example
+    #   app.timefield(id: 'id', label: 'label', class: 'YTimeField')
+    def timefield(filter)
+      Widgets::Timefield.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Textbox with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Textbox] new instance of Textbox
+    # @example
+    #   app.textbox(id: 'id', label: 'label', class: 'YInputField')
+    def textbox(filter)
+      Widgets::Textbox.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Tree with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Tree] new instance of Tree
+    # @example
+    #   app.tree(id: 'id', label: 'label', class: 'YTree')
+    def tree(filter)
+      Widgets::Tree.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Initializes new instance of Wizard with the filter provided.
+    # Does not make request to libyui-rest-api.
+    # @param filter [Hash] filter to find a widget
+    # @return [Widgets::Wizard] new instance of Wizard
+    # @example
+    #   app.wizard(id: 'id', label: 'label', class: 'YWizard')
+    def wizard(filter)
+      Widgets::Wizard.new(@widget_controller, FilterExtractor.new(filter))
+    end
+
+    # Returns client side libyui REST API version
+    # @return libyui client REST API version
+    def client_api_version
+      API_VERSION
+    end
+
+    # Returns server side libyui REST API version
+    # @return libyui server REST API version
+    def server_api_version
+      @version_controller.api_version
+    end
+
+    # Validates if server side REST API is compatible with client inside
+    # @return true if version is compatible, false if not or any error while
+    #         receiving version from the server
+    def check_api_version
+      LibyuiClient.logger.info("Client API version: #{API_VERSION}")
+      server_api_v = server_api_version
+      raise Error::LibyuiClientError if server_api_v.nil?
+
+      LibyuiClient.logger.info("Server API version: #{server_api_v}")
+      server_api_v <= client_api_version
+    end
+  end
+end