bucky-core 0.9.0

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bucky/core'
+
+# 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

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/bucky-core.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bucky/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bucky-core'
+  spec.version       = Bucky::Version::VERSION
+  spec.authors       = %w[NaotoKishino HikaruFukuzawa SeiyaSato NaokiNakano RikiyaHikimochi JyeRuey]
+  spec.email         = ['KishinoNaoto@lifull.com']
+
+  spec.summary = 'A test framework that supports Life Cycle of System Testing.'
+  spec.description = <<-DESCRIPTION
+    Bucky support run in parellel, test results managed in database, and some test categories(E2E, http status check) and so on.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/lifull-dev/bucky-core'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f|
+    f.match(%r{^(test|spec|features)/})
+  }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'awesome_print',  '~> 1.8'
+  spec.add_development_dependency 'bundler',        '~> 1.15'
+  spec.add_development_dependency 'hirb',           '~> 0.7'
+  spec.add_development_dependency 'pry',            '~> 0.10'
+  spec.add_development_dependency 'pry-byebug',     '~> 3.4'
+  spec.add_development_dependency 'pry-stack_explorer', '~> 0.4'
+  spec.add_development_dependency 'rake',           '~> 12'
+  spec.add_development_dependency 'rspec',          '~> 3.6'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3'
+  spec.add_development_dependency 'rubocop',        '~> 0.54'
+  spec.add_development_dependency 'simplecov-console', '~> 0.4.2'
+
+  spec.add_runtime_dependency 'color_echo',         '~> 3.1'
+  spec.add_runtime_dependency 'json',               '~> 2.1'
+  spec.add_runtime_dependency 'nokogiri',           '~> 1.8'
+  spec.add_runtime_dependency 'parallel',           '~> 1.11'
+  spec.add_runtime_dependency 'ruby-mysql',         '~> 2.9'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 3.4'
+  spec.add_runtime_dependency 'sequel',             '~> 4.48'
+  spec.add_runtime_dependency 'test-unit',          '~> 3.2'
+end

data/docker-compose.dev-with-bm.yml

@@ -0,0 +1,28 @@
+version: '3'
+services:
+  bucky-core:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: bucky-core
+    volumes:
+      - .:/bucky-core
+      - .sample:/app
+    tty: true
+    environment:
+      - BUCKY_DB_USERNAME=root
+      - BUCKY_DB_PASSWORD=password
+      - BUCKY_DB_HOSTNAME=bm-mysql
+      - BUCKY_DB_NAME=bucky_development
+    networks:
+      - bucky-management_default
+  chrome:
+    image: selenium/standalone-chrome-debug:3.11.0
+    container_name: chrome
+    ports:
+      - '4444:4444'
+      - '5901:5900'
+    shm_size: 1G
+networks:
+  bucky-management_default:
+    external: true

data/docker-compose.dev.yml

@@ -0,0 +1,18 @@
+version: '3'
+services:
+  bucky-core:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: bucky-core
+    volumes:
+      - .:/bucky-core
+      - .sample:/app
+    tty: true
+  chrome:
+    image: selenium/standalone-chrome-debug:3.11.0
+    container_name: chrome
+    ports:
+      - '4444:4444'
+      - '5901:5900'
+    shm_size: 1G

data/docker-compose.system-test.yml

@@ -0,0 +1,21 @@
+version: '3'
+services:
+  bucky-core:
+    container_name: bucky-core
+    build:
+      context: .
+      dockerfile: Dockerfile.system-test
+    volumes:
+      - .:/bucky-core
+    tty: true
+  chrome:
+    container_name: bucky-chrome
+    image: selenium/standalone-chrome-debug:3.11.0
+    ports:
+      - '4444:4444'
+      # For local debug
+      - '5901:5900'
+  web:
+    container_name: bucky.net
+    build:
+      context: docker/nginx

data/docker/nginx/Dockerfile

@@ -0,0 +1,7 @@
+FROM nginx:1.13
+RUN rm -f /etc/nginx/conf.d/*
+RUN rm -f /usr/share/nginx/html/*
+
+COPY ./public /app/public
+ADD ./nginx.conf /etc/nginx/nginx.conf
+CMD /usr/sbin/nginx -g 'daemon off;' -c /etc/nginx/nginx.conf

data/docker/nginx/nginx.conf

@@ -0,0 +1,22 @@
+user nginx;
+
+events {
+    worker_connections 128;
+}
+
+http {
+  access_log /var/log/nginx/access.log;
+  error_log /var/log/nginx/error.log;
+
+  server_tokens off;
+  index index.html;
+
+  server {
+    listen 80;
+    server_name localhost;
+
+    location /{
+      root /app/public;
+    }
+  }
+}

data/docker/nginx/public/index.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+<title>Test Index</title>
+
+<script type="text/javascript">
+    window.onload = function () {
+        document.getElementById( "user_agent" ).innerHTML = navigator.userAgent;
+    }
+</script>
+</head>
+
+<body>
+    <a id="test_link" href="/test_page.html">Go to test page</a>
+    <div id="user_agent"></div>
+</body>
+
+</html>

data/docker/nginx/public/test_page.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+<title>Test Page</title>
+</head>
+
+<body>
+    <h1>This is a Test page</h1>
+</body>
+
+</html>

data/exe/bucky

@@ -0,0 +1,214 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'optparse'
+require 'color_echo'
+require 'fileutils'
+require_relative '../lib/bucky/version'
+
+# Color Settings
+CE.fg(:cyan)
+
+NEW_COMMAND = %w[new].freeze
+MAKE_SERVICE_COMMAND = %w[make service].freeze
+MAKE_PAGE_COMMAND = %w[make page].freeze
+RUN_COMMAND = %w[run].freeze
+RERUN_COMMAND = %w[rerun].freeze
+LINT_COMMAND = %w[lint].freeze
+
+# ===================================
+# Parse options =====================
+# ===================================
+opts = OptionParser.new
+opts.banner = 'Bucky: A test framework that supports Life Cycle of System Testing.'
+opts.define_head 'Usage: bucky [task]'
+opts.separator ''
+opts.separator 'Examples:'
+opts.separator "  bucky #{RUN_COMMAND.join(' ')} --test_category e2e --suite_name test_suite --case_name test_case_1"
+opts.separator "  bucky #{RUN_COMMAND.join(' ')} -t e2e -s 1 -c 1"
+opts.separator "  bucky #{RUN_COMMAND.join(' ')} --test_category linkstatus --re_test_count 3"
+opts.separator "  bucky #{RUN_COMMAND.join(' ')} --test_category e2e --suite_name test_suite --case_name test_case_1 --device sp --priority high --re_test_count 3"
+opts.separator ''
+opts.separator 'For more information see https://github.com/lifull-dev/bucky-core'
+opts.separator ''
+opts.separator 'Options:'
+
+opts.on_tail('-h', '-?', '--help', 'Show this message') do
+  puts opts
+  exit
+end
+
+opts.on_tail('-v', '--version', 'Show version') do
+  puts "BuckyCore: #{Bucky::Version::VERSION}"
+  exit
+end
+
+test_cond = {}
+# Save command and option
+test_cond[:command_and_option] = 'bucky ' + ARGV.join(' ')
+opts.on('-t', '--test_category TEST_CATEGORY', 'e.g. --test_category e2e, -t e2e') do |v|
+  test_cond[:test_category] = v
+end
+opts.on('-s', '--suite_name SUITE_NAME') do |v|
+  test_cond[:suite_name] = v
+end
+# opts.on('-c', '--case_id CASE_ID') do |v|
+#  test_cond[:case_id] = v
+# end
+opts.on('-S', '--service SERVICE') do |v|
+  test_cond[:service] = v
+end
+opts.on('-D', '--device DEVICE') do |v|
+  test_cond[:device] = v
+end
+opts.on('-p', '--priority PRIORITY') do |v|
+  test_cond[:priority] = v
+end
+opts.on('-d', 'Not Insert TestReport') do |_|
+  $debug = true
+end
+
+# TODO: Add error handling, if the argument of '-r' is not greater than 0
+opts.on('-r', '--re_test_count RE_TEST_COUNT') do |v|
+  test_cond[:re_test_count] = v
+end
+opts.on('-c', '--case CASE_NAME') do |v|
+  test_cond[:case] = v
+end
+opts.on('-j', '--job_id JOB_ID') do |v|
+  test_cond[:job] = v
+end
+opts.on('-l', '--label LABEL_NAME') do |v|
+  test_cond[:label] = v
+end
+opts.on('-m', '--link_check_max_times') do |v|
+  test_cond[:link_check_max_times] = v.to_i
+end
+
+lint_cond = {}
+opts.on('-C', '--category CATEGORY_NAME') do |v|
+  lint_cond[:lint_category] = v
+end
+
+opts.parse!
+
+# ===================================
+# Select by command =================
+# ===================================
+
+# Output error message and exit
+# @param [String] msg error message
+def error_and_exit(msg = nil)
+  CE.fg(:yellow)
+  puts 'Invalid command error.'
+  CE.fg(:red)
+  puts "  [Error] #{msg}" if msg
+  CE.fg(:yellow)
+  puts "  your command : bucky #{ARGV.join(' ')}"
+  puts '  Please input some commands.'
+  puts "  e.g. bucky #{NEW_COMMAND.join(' ')}"
+  puts "       bucky #{RUN_COMMAND.join(' ')}"
+  puts "       bucky #{MAKE_SERVICE_COMMAND.join(' ')}"
+  puts "       bucky #{MAKE_PAGE_COMMAND.join(' ')}"
+  puts "       bucky #{RERUN_COMMAND.join(' ')}"
+  puts "       bucky #{LINT_COMMAND.join(' ')}"
+  exit
+end
+
+def bucky_home?
+  File.exist?('.bucky_home')
+end
+
+current_dir = Dir.pwd
+gem_script_dir = __dir__
+
+if ARGV == RUN_COMMAND
+  error_and_exit('Not bucky project dirctory here.') unless bucky_home?
+
+  $bucky_home_dir = Dir.pwd
+  # Default conditions setting conditions setting
+  test_cond[:test_category] ||= 'e2e'
+  test_cond[:re_test_count] = test_cond[:re_test_count] ? test_cond[:re_test_count].to_i : 1
+  test_cond[:link_check_max_times] ||= 3
+  # Change to array e.g.--suite_id 1,2,3 -> :suite_id=>[1,2,3]
+  test_cond.each { |k, v| test_cond[k] = v.split(',') if v.instance_of?(String) }
+  require_relative '../lib/bucky/core/test_core/test_manager'
+  Bucky::Core::TestCore::TestManager.new(test_cond).run
+
+elsif ARGV == RERUN_COMMAND
+  $bucky_home_dir = Dir.pwd
+  # Default conditions setting conditions setting
+  test_cond[:test_category] ||= 'e2e'
+  test_cond[:link_check_max_times] ||= 3
+  test_cond[:re_test_count] = test_cond[:re_test_count] ? test_cond[:re_test_count].to_i : 1
+  # Change to array e.g.--suite_id 1,2,3 -> :suite_id=>[1,2,3]
+  test_cond.each { |k, v| test_cond[k] = v.split(',') if v.instance_of?(String) }
+  require_relative '../lib/bucky/core/test_core/test_manager'
+  Bucky::Core::TestCore::TestManager.new(test_cond).rerun
+
+elsif ARGV == LINT_COMMAND
+  $bucky_home_dir = Dir.pwd
+  # Default conditions setting
+  lint_cond[:lint_category] ||= 'config'
+  require_relative '../lib/bucky/tools/lint'
+  Bucky::Tools::Lint.check(lint_cond[:lint_category])
+
+elsif ARGV[0..0] == NEW_COMMAND
+  error_and_exit('No test app name.') if ARGV.length < 2
+
+  # Copy template
+  FileUtils.cp_r("#{gem_script_dir}/../template/new/", current_dir, verbose: true)
+  # Rename dir
+  FileUtils.mv("#{current_dir}/new", "#{current_dir}/#{ARGV[1]}", verbose: true)
+
+elsif ARGV[0..1] == MAKE_SERVICE_COMMAND
+  error_and_exit('Not bucky project dirctory here.') unless bucky_home?
+  error_and_exit('No service name.') if ARGV.length < 3
+
+  service_name = ARGV[2]
+
+  # Check if there is any directory in same service name.
+  error_and_exit("Already exist #{service_name} directory.") if File.exist?("#{current_dir}/services/#{service_name}")
+  FileUtils.mkdir("#{current_dir}/services/#{service_name}", verbose: true)
+
+elsif ARGV[0..1] == MAKE_PAGE_COMMAND
+  support_device = %w[pc sp tablet]
+  error_and_exit('Not bucky project dirctory here.') unless bucky_home?
+  error_and_exit('No page name.') if ARGV.length < 3
+  error_and_exit('No service name.') unless test_cond[:service]
+
+  # Default conditions setting
+  test_cond[:device] ||= 'pc'
+
+  error_and_exit("#{test_cond[:device]} device is not supported. (only pc/sp/tablet.)") unless support_device.include?(test_cond[:device])
+
+  page_name = ARGV[2]
+  pageobject_dir = "#{current_dir}/services/#{test_cond[:service]}/#{test_cond[:device]}/pageobject"
+  pageobject_rb = "#{pageobject_dir}/#{page_name}.rb"
+  parts_dir = "#{current_dir}/services/#{test_cond[:service]}/#{test_cond[:device]}/parts"
+  parts_file = "#{parts_dir}/#{page_name}.yml"
+
+  error_and_exit("Already exist pageobject file: #{pageobject_rb}.") if File.exist?(pageobject_rb)
+  error_and_exit("Already exist parts file: #{parts_file}.") if File.exist?(parts_file)
+  FileUtils.mkdir_p("#{current_dir}/services/#{test_cond[:service]}/#{test_cond[:device]}")
+  FileUtils.cp_r(
+    "#{gem_script_dir}/../template/make_page/#{test_cond[:device]}",
+    "#{current_dir}/services/#{test_cond[:service]}",
+    verbose: true
+  )
+
+  FileUtils.mv("#{pageobject_dir}/sample_page.rb", pageobject_rb, verbose: true)
+  FileUtils.mv("#{parts_dir}/sample_page.yml", parts_file, verbose: true)
+
+  # Change service name and page name on pageobject
+  # | {SampleService} -> ServiceName
+  # | {SamplePage} -> PageName
+  script = File.open(pageobject_rb).read
+  split_and_capitalize = proc { |str| str.split(/_|-/).map(&:capitalize).join }
+  script.sub!('{SampleService}', split_and_capitalize.call(test_cond[:service]))
+  script.sub!('{SamplePage}', split_and_capitalize.call(page_name))
+  File.open(pageobject_rb, 'w+') { |f| f.write script }
+else
+  error_and_exit
+end

data/lib/bucky.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bucky/version'

data/lib/bucky/core/database/db_connector.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'sequel'
+require_relative '../exception/bucky_exception'
+require_relative '../../utils/config'
+
+module Bucky
+  module Core
+    module Database
+      class DbConnector
+        attr_reader :con
+        def initialize
+          @test_db_config = Bucky::Utils::Config.instance[:test_db]
+        end
+
+        # Connect to database
+        # @param [String] db_name database name
+        def connect(db_name = 'bucky_test')
+          @con = Sequel.connect(@test_db_config[db_name.to_sym], encoding: 'utf8')
+        end
+
+        # Disconnect to database
+        def disconnect
+          @con.disconnect
+        end
+      end
+    end
+  end
+end