bucky-core 0.9.0

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,246 @@
+# Bucky-Core
+
+## Overview
+
+Bucky is a testing framework that supports web system testing life cycle.
+
+## Feature
+
+* Run tests in parallel
+* Re-run tests which failed last time
+* Support test code in YAML
+* Multiple browser supported (Currently only Chrome is supported)
+* Customizable test categories
+  * [Default] E2E: E2E (End to End) tests including JavaScript error check
+  * [Default] Linkstatus: http status code check in web page
+* Making test Report with [bucky-management](https://github.com/lifull-dev/bucky-management)
+
+
+## Setup
+
+### Install
+```bash
+gem install bucky-core
+```
+
+### Implement test code
+```bash
+# Make project directory
+bucky new {your_project_name}
+
+# Make service directory
+bucky make service {your_service_name}
+
+# Make page object(.rb) and part(.yml) in device directory
+## PC
+bucky make page {page_name} --service {your_service_name} --device pc
+## Smart phone
+bucky make page {page_name} --service {your_service_name} --device sp
+## Tablet
+bucky make page {page_name} --service {your_service_name} --device tablet
+
+# Write your test code in following directory:
+# services/{your_service_name}/{device}/scenarios/e2e/
+# services/{your_service_name}/{device}/scenarios/linkstatus/
+
+# Some samples are at bottom of Usage
+vim services/first_serive/pc/scenarios/e2e/test_code.yml
+```
+
+### Set connecting information for database
+
+```bash
+export BUCKY_DB_USERNAME="{your database username}"
+export BUCKY_DB_PASSWORD="{your database password}"
+export BUCKY_DB_HOSTNAME="{your database hostname}"
+export BUCKY_DB_NAME="{your database name}"
+```
+
+## Usage
+
+### Run test
+```bash
+# Condition filter using option
+bucky run --test_category e2e --device sp --priority high
+bucky run --test_category e2e --case login
+bucky run --test_category e2e -D tablet --priority high
+bucky run --test_category e2e -D pc --label foo,bar,baz --priority high
+# Run test in debug mode (It won't insert test result into DB)
+bucky run -t e2e -d
+# Use -r to run more times for flaky test
+# It will only run tests that failed in last count
+bucky run --test_category e2e --re_test_count 3
+bucky run -t linkstatus -s bukken_detail -D pc -r 3
+# Use environment variables in test
+ENV_FOO=foo bucky run -t e2e -d
+
+# Options:
+    -d, --debug # Won't insert test result into DB
+    -t, --test_category TEST_CATEGORY
+    -s, --suite_name SUITE_NAME
+    -S, --service SERVICE
+    -c, --case CASE_NAME
+    -D, --device DEVICE
+    -p, --priority PRIORITY
+    -r, --re_test_count RE_TEST_COUNT # How many round you run tests
+    -l, --label LABEL_NAME
+    -m, --link_check_max_times MAX_TIMES # Works only with which category is linkstatus
+```
+
+### Rerun test
+```bash
+# Only work with saved test result
+# Rerun from job id
+bucky rerun -j 100
+bucky rerun -j 100 -r 3
+
+# Options:
+    -d, --debug # Won't insert test result into DB
+    -r, --re_test_count RE_TEST_COUNT # How many round you run tests
+    -j, --job_id JOB_ID
+```
+
+#### Sample E2E test_code.yml
+
+* You can use erb notation in test code
+* [Operation list](https://github.com/lifull-dev/bucky-core/blob/master/lib/bucky/test_equipment/user_operation/user_operation_helper.rb)
+* [Verification list](https://github.com/lifull-dev/bucky-core/blob/master/lib/bucky/test_equipment/verifications/e2e_verification.rb)
+
+```yaml
+desc: suite description
+device: pc
+service: service_name
+priority: high
+test_category: e2e
+labels: test_label_foo
+setup_each: # Thess procedures will be executed before every case
+  procs:
+    - proc: login
+      exec:
+        operate: go
+        url: https://example.com/login
+teardown_each: # These procedures will be executed after every case
+  procs:
+    - proc: login
+      exec:
+        operate: go
+        url: https://example.com/logout
+
+cases:
+  - case_name: test_code_1 # Suite filename + number
+    func: inquire button
+    desc: case description
+    labels:
+      - test_label_bar
+      - test_label_baz
+    procs:
+      - proc: open page
+        exec:
+          operate: go
+          url: http://example.com/
+      - proc: open page
+        exec:
+          operate: go
+          url: <%= ENV['FQDN'] %>/results # Using erb notation to get environment variable
+      - proc: element click
+        exec:
+          operate: click
+          page: top
+          part: next_page
+        when: <%= ENV['STAGE'] == development %> # Executing this proc when this condition is true
+      - proc: one of elements click # Using xpaths
+        exec:
+          operate: click
+          page: next_page # This file is at services/service_name/pc/parts/next_page.yml
+          part:
+            locate: many_links #  many_links is a xpath that describe in services/service_name/pc/parts/next_page.yml
+            num: 0 # You can choose number of element when xpath have multiple elements
+      - proc: switch tab
+        exec:
+          operate: switch_next_window
+      - proc: select by drop down
+        exec:
+          operate: choose
+          page: input_page
+          part: age
+          text: 20
+      - proc: alert accept
+        exec:
+          operate: alert_accept
+      - exec:
+          operate: wait
+          sec: 2
+      - exec: # You can stop your test by using stop operator
+          operate: stop
+      - proc: check message
+        exec:
+          verify: assert_text
+          page: input_thanks
+          part: complete_message
+          expect: done
+      - proc: check message
+        exec:
+          verify: assert_contained_text
+          page: input_thanks
+          part: complete_message
+          expect: done
+```
+
+#### Sample linkstatus test_code.yml
+
+* linkstatus will check every \<a> tag's http response in url
+
+```yaml
+desc: suite description
+device: pc
+service: service_name
+priority: high
+test_category: linkstatus
+exclude_urls:
+  - https://example.com/fuga/?hoge=1 # PERFECT MATCHING
+  - https://example.com/fuga/* # PARTIAL MATCHING
+cases:
+  - case_name: test_code_1 # Suite filename + number
+    desc: status check for top page
+    urls:
+        - https://example.com/
+        - https://www.example.com/
+  - case_name: test_code_2
+    desc: status check for detail page
+    urls:
+        - https://example.com/detail/1
+        - <%= ENV['FQDN'] %>/detail/2 # Using erb notation to get environment variable
+```
+
+# Development
+
+## Development
+Should always execute bucky run with -d option
+```bash
+git clone git@github.com:lifull-dev/bucky-core.git
+cd bucky-core
+# clone from some test code
+git clone git@github.com:${sample_test_code_owner}/${sample_testcode}.git .sample
+docker-compose -f docker-compose.dev.yml up --build -d
+docker-compose -f docker-compose.dev.yml down
+```
+
+## Development with bucky-management
+You should start bucky-management first.
+
+```bash
+git clone git@github.com:lifull-dev/bucky-core.git
+cd bucky-core
+git clone git@github.com:${sample_test_code_owner}/${sample_testcode}.git .sample
+docker-compose -f docker-compose.dev-with-bm.yml up --build -d
+docker-compose -f docker-compose.dev-with-bm.yml down
+```
+
+## Contributing
+
+* [Naoto Kishino](https://github.com/kishinao)
+* [Rikiya Hikimochi](https://github.com/hikimocr)
+* [Jye Ruey](https://github.com/rueyjye)
+* [Seiya Sato](https://github.com/satose)
+* [Hikaru Fukuzawa](https://github.com/FukuzawaHikaru)
+* [Naoki Nakano](https://github.com/NakanoNaoki)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec