bucky-core 0.9.0

data/lib/bucky/tools/lint.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative '../utils/yaml_load'
+
+module Bucky
+  module Tools
+    class Lint
+      class << self
+        include Bucky::Utils::YamlLoad
+        @@config_dir = "#{$bucky_home_dir}/config/**/*yml"
+        @@rule_config_dir = "#{$bucky_home_dir}/.bucky-core/template/new/config/*yml"
+
+        def check(category)
+          method = "check_#{category}".to_sym
+          respond_to?(method) ? send(method) : raise(StandardError, "no such a category #{category}")
+        end
+
+        # If you want to add new category, please make new method
+        def check_config
+          data = merge_yaml_data(@@config_dir)
+          rule_data = merge_yaml_data(@@rule_config_dir)
+          actual = make_key_chain(data)
+          expect = make_key_chain(rule_data)
+          diff = diff_arr(expect, actual)
+          make_message(diff)
+        end
+
+        private
+
+        # Merge yaml in target directory.
+        def merge_yaml_data(dir)
+          data_output = {}
+          file_sort_hierarchy(dir).each do |file|
+            data = load_yaml(file)
+            data_output.merge!(data) unless data.empty?
+          end
+          data_output.any? ? data_output : (raise StandardError, "No key! please check the directory existence [#{dir}]")
+        end
+
+        def make_message(diff)
+          if diff.empty?
+            puts "\e[32mok\e[0m"
+          else
+            puts "\e[31m[ERROR] The following configures are undefined."
+            diff.each do |key|
+              puts "- #{key}\e[0m"
+            end
+          end
+        end
+
+        def diff_arr(expect, actual)
+          expect.delete_if do |i|
+            actual.include?(i)
+          end
+        end
+
+        def make_key_chain(hash)
+          hash.map do |k, v|
+            if v.is_a? Hash
+              make_key_chain(v).map { |item| "#{k}-#{item}" }
+            else
+              k.to_s
+            end
+          end.flatten
+        end
+      end
+    end
+  end
+end

data/lib/bucky/utils/bucky_logger.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'logger'
+require_relative './config'
+
+module Bucky
+  module Utils
+    module BuckyLogger
+      LogFileDir = Bucky::Utils::Config.instance.data[:log_path]
+      # Write following logs
+      # - user opareation (e.g. test_sample_app_pc_e2e_1_1.log)
+      # - verification (e.g. test_sample_app_pc_e2e_1_1.log)
+      # - Error of Bucky core (bucky_error.log)
+      # @param [String] file_name
+      # @param [String] or [Execption] content
+      def write(file_name, content)
+        puts "    #{content}"
+        logger = Logger.new("#{LogFileDir}#{file_name}.log", 1)
+        logger.info content
+        logger.close
+      end
+      module_function :write
+    end
+  end
+end

data/lib/bucky/utils/bucky_output.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Bucky
+  module Utils
+    module BuckyOutput
+      module StringColorize
+        refine String do
+          def black
+            "\e[30m#{self}\e[0m"
+          end
+
+          def bg_red
+            "\e[41m#{self}\e[0m"
+          end
+
+          def bg_green
+            "\e[42m#{self}\e[0m"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bucky/utils/config.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require_relative './yaml_load'
+
+module Bucky
+  module Utils
+    class Config
+      include Bucky::Utils::YamlLoad
+      include Singleton
+      @@dir = "#{$bucky_home_dir}/config/**/*yml"
+
+      # @param [String] *.yml or hoge/fuga.yml
+      def initialize
+        @data = {}
+        @resources = []
+
+        # Read from a file of shallow hierarchy, then overwrite it if there is same key in deep hierarchy
+        file_sort_hierarchy(@@dir).each do |file|
+          data = load_yaml(file)
+          unless data.empty?
+            @data = @data.merge(data)
+            @resources << file
+          end
+        end
+
+        set_selenium_ip
+      end
+
+      # @return [Hash] loaded data
+      def data
+        @data || {}
+      end
+
+      # Get data by []
+      def [](column)
+        return data[column] if data.key?(column)
+
+        # If there is no key, raise exeption
+        raise "Undefined Config : #{column}\nKey doesn't match in config file. Please check config file in config/*"
+      end
+
+      private
+
+      def set_selenium_ip
+        return unless @data[:selenium_ip] == 'docker_host_ip'
+
+        selenium_ip = `ip route | awk 'NR==1 {print $3}'`.chomp
+        raise StandardError, 'Could not load docker host ip.' if selenium_ip.empty?
+
+        @data[:selenium_ip] = selenium_ip
+      end
+    end
+  end
+end

data/lib/bucky/utils/requests.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+
+module Bucky
+  module Utils
+    module Requests
+      USER_AGENT_STRING = {
+        pc: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/49.0.2623.112 Safari/537.36',
+        sp: 'Mozilla/5.0 (iPhone; CPU iPhone OS 9_3_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13E238 Safari/601.1'
+      }.freeze
+
+      # @param  [String]    uri
+      # @param  [String]    device
+      # @param  [Integer/Float] open_timeout max wait time until open page
+      # @param  [Integer/Float] read_timeout max wait time until recieve response
+      # @return [Net::HTTP]         HttpStatusCode
+      def get_response(uri, device, open_timeout, read_timeout)
+        parsed_uri = URI.parse(uri.to_str.strip)
+        query = parsed_uri.query ? "?#{parsed_uri.query}" : ''
+        # If path is empty, add "/" e.g) http://example.com
+        path = parsed_uri.path.empty? ? '/' : parsed_uri.path
+
+        Net::HTTP.start(parsed_uri.host, parsed_uri.port, use_ssl: parsed_uri.scheme == 'https') do |http|
+          http.open_timeout = open_timeout
+          http.read_timeout = read_timeout
+          http.get("#{path}#{query}", 'User-Agent' => USER_AGENT_STRING[device.to_sym])
+        end
+      end
+    end
+  end
+end

data/lib/bucky/utils/yaml_load.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'erb'
+
+module Bucky
+  module Utils
+    module YamlLoad
+      # Load yaml(include erb)
+      # @param [File] yaml file
+      # @return [Hash] hashed yaml contents
+      def load_yaml(file)
+        YAML.safe_load(ERB.new(File.read(file)).result, [Array, Hash, String, Numeric, Symbol, TrueClass, FalseClass], [], true)
+      end
+
+      # Sort files to hierarchy
+      # @param [String] path of directory
+      # @return [Array] sorted files
+      def file_sort_hierarchy(path)
+        Dir.glob(path).sort_by { |f| f.split('/').size }
+      end
+    end
+  end
+end

data/lib/bucky/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bucky
+  module Version
+    VERSION = '0.9.0'
+  end
+end

data/system_testing/test_bucky_project/.bucky_home

@@ -0,0 +1,2 @@
+# bucky home directory.
+# Do not delete this file.

data/system_testing/test_bucky_project/config/bucky_config.yml

@@ -0,0 +1,6 @@
+:parallel_num: 4
+:test_result_path: './system/test_results/'
+:log_path: './system/logs/'
+:screen_shot_path: './system/evidences/screen_shots/'
+:bucky_error: 'bucky_error'
+:test_code_repo: 'https://github.com/hogehoge/fugafuga/'

data/system_testing/test_bucky_project/config/e2e_config.yml

@@ -0,0 +1,15 @@
+:selenium_ip: 'docker_host_ip'  # Default selenium ip. please set ip or 'docker_host_ip'. ip route | awk 'NR==1 {print $3}'
+:selenium_port: '4444'     # Default selenium port
+:browser: :chrome          # Only chrome
+:sp_device_name: :iphone
+:tablet_device_name: :ipad
+:device_name_on_chrome:
+  :iphone: 'iPhone X'
+  :android: 'Galaxy S5'
+  :ipad: 'iPad'
+:user_agent: 'E2ETest (X11; Linux x86_64)'
+:js_error_check: true
+:js_error_collector_path: '/var/lib/selenium/ChromeJSErrorCollector-master/extension' # https://github.com/dharrya/ChromeJSErrorCollector
+:driver_read_timeout: 60 # sec
+:driver_open_timeout: 60 # sec
+:find_element_timeout: 10 # sec

data/system_testing/test_bucky_project/config/linkstatus_config.yml

@@ -0,0 +1,3 @@
+:linkstatus_parallel_num: 8
+:linkstatus_open_timeout: 60
+:linkstatus_read_timeout: 60

data/system_testing/test_bucky_project/config/test_db_config.yml

@@ -0,0 +1,8 @@
+:test_db:
+  :bucky_test:
+    :username: <%= ENV['BUCKY_DB_USERNAME'] %>
+    :password:  <%= ENV['BUCKY_DB_PASSWORD'] %>
+    :database: 'bucky_development'
+    :host:  <%= ENV['BUCKY_DB_HOST'] %>
+    :port: 3306
+    :adapter: :mysql

data/system_testing/test_bucky_project/services/README.md

@@ -0,0 +1 @@
+for services page and parts objects.

data/system_testing/test_bucky_project/services/service_a/pc/pageobject/index.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bucky/test_equipment/pageobject/base_pageobject'
+module Services
+  module ServiceA
+    module Pc
+      module PageObject
+        class Index < Bucky::TestEquipment::PageObject::BasePageObject
+        end
+      end
+    end
+  end
+end

data/system_testing/test_bucky_project/services/service_a/pc/parts/index.yml

@@ -0,0 +1,6 @@
+link:
+   - xpath
+   - "//*[@id='test_link']"
+ua:
+   - xpath
+   - "//*[@id='user_agent']"

data/system_testing/test_bucky_project/services/service_a/pc/scenarios/e2e/pc_e2e.yml

@@ -0,0 +1,68 @@
+desc: pc e2e suits
+device: pc
+service: service_a
+priority: high
+test_category: e2e
+cases:
+  - case_name: pc_e2e_1
+    func: pc e2e 1 func
+    desc: pc e2e 1 func
+    procs:
+      - proc: open index
+        exec:
+          operate: go
+          url: http://bucky.net
+      - proc: open index
+        exec:
+          operate: click
+          page: index
+          part: link
+      - proc: check title
+        exec:
+          verify: assert_title
+          expect: Test Page
+  - case_name: pc_e2e_2
+    func: pc e2e 2 func
+    desc: pc e2e 2 func
+    procs:
+      - proc: open index
+        exec:
+          operate: go
+          url: http://bucky.net
+      - proc: open index
+        exec:
+          operate: click
+          page: index
+          part: link
+      - proc: check title(NG)
+        exec:
+          verify: assert_title
+          expect: Test Page Wrong
+  - case_name: pc_e2e_3
+    func: pc e2e 3 func UserAgent
+    desc: pc e2e 3 func UserAgent
+    procs:
+      - proc: open index
+        exec:
+          operate: go
+          url: http://bucky.net
+      - proc: check UserAgent(OS)
+        exec:
+          verify: assert_contained_text
+          page: index
+          part: ua
+          expect: Linux
+  - case_name: pc_e2e_4
+    func: pc e2e 4 func when
+    desc: pc e2e 4 func when
+    procs:
+      - proc: open index
+        exec:
+          operate: go
+          url: http://bucky.net
+      - proc: index
+        exec:
+          operate: click
+          page: index
+          part: link
+        when: <%= ENV['STAGE'] == 'development' %>

data/system_testing/test_bucky_project/services/service_a/pc/scenarios/e2e/setup_each_pc_e2e.yml

@@ -0,0 +1,20 @@
+desc: setup each pc e2e suits
+device: pc
+service: service_a
+priority: high
+test_category: e2e
+setup_each:
+    procs:
+      - proc: open index
+        exec:
+          operate: go
+          url: http://bucky.net
+cases:
+  - case_name: setup_each_pc_e2e_1
+    func: setup each pc e2e 1 func
+    desc: setup each pc e2e 1 func
+    procs:
+      - proc: check title
+        exec:
+          verify: assert_title
+          expect: Test Index

data/system_testing/test_bucky_project/services/service_a/pc/scenarios/e2e/setup_teardown_each_pc_e2e.yml

@@ -0,0 +1,35 @@
+desc: setup teardown each pc e2e suits
+device: pc
+service: service_a
+priority: high
+test_category: e2e
+setup_each:
+    procs:
+      - proc: open index
+        exec:
+          operate: go
+          url: http://bucky.net
+teardown_each:
+    procs:
+      - proc: open test_page.html
+        exec:
+          operate: go
+          url: http://bucky.net/test_page.html
+
+cases:
+  - case_name: setup_teardown_each_pc_e2e_1
+    func: setup teardown each pc e2e 1 func
+    desc: setup teardown each pc e2e 1 func
+    procs:
+      - proc: check title
+        exec:
+          verify: assert_title
+          expect: Test Index
+  - case_name: setup_teardown_each_pc_e2e_2
+    func: setup teardown each pc e2e 2 func
+    desc: setup teardown each pc e2e 2 func
+    procs:
+      - proc: check title
+        exec:
+          verify: assert_title
+          expect: Test Index