bunyan_capybara 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0c3ab43b32d6e7b62a494a7471edeafe5333900a
4
+ data.tar.gz: 845e66663824959ecfe49031e21eccf09136ad57
5
+ SHA512:
6
+ metadata.gz: f4e1f8eb4e5aa8a17b239d82d0159930546e965ff7dea2828813f3e4c2ad93ea9da51c419a59edefa693bc422f95812bf862cbd334f6f1c6001e5c948499e6f4
7
+ data.tar.gz: 918fb0d4009fdc2769e7731bca85faec5afae4ac0ff25c8865b925c00664e611344ea81af99f33fc462627fab41bd26c9070a72ca8f3d8487768ab75cef27bae
data/.gitignore ADDED
@@ -0,0 +1,13 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ /logs/*.log
11
+
12
+ # rspec failure tracking
13
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.0
5
+ before_install: gem install bundler -v 1.14.6
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in bunyan_capybara.gemspec
4
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # BunyanCapybara
2
+
3
+ ## To Do List
4
+
5
+ - [x] Transfer over ExampleLogging module core code
6
+ - [x] Transfer and rename the example_varibable_extractor.rb file into lib/bunyan/
7
+ - [x] Test if Bunyan module is working
8
+ - [x] Transfer the Capybara injections (click, trigger, etc.) from ExampleLogging
9
+ - [x] **if needed**: transfer and rename the example_logging_constants file to lib/bunyan/
10
+ - [ ] Organize file/folder names and organization as per convention (Jeremy's assistance likely needed)
11
+ - [ ] Final test for complete functionality of Bunyan Gem
12
+
13
+ ## Installation
14
+
15
+ Add this line to your application's Gemfile:
16
+
17
+ ```ruby
18
+ gem 'bunyan_capybara'
19
+ ```
20
+
21
+ And then execute:
22
+
23
+ $ bundle
24
+
25
+ Or install it yourself as:
26
+
27
+ $ gem install bunyan_capybara
28
+
29
+ ## Usage
30
+
31
+ TODO: Write usage instructions here
32
+
33
+ ## Development
34
+
35
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
36
+
37
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
38
+
39
+ ## Contributing
40
+
41
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bunyan_capybara.
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "bunyan_capybara"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'bunyan_capybara/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "bunyan_capybara"
8
+ spec.version = BunyanCapybara::VERSION
9
+ spec.authors = ["Max Hallwachs"]
10
+ spec.email = ["mhallwac@nd.edu"]
11
+
12
+ spec.summary = %q{Logger}
13
+ spec.description = %q{adds loggin capabilities}
14
+ spec.homepage = "https://github.com/ndlib/bunyan_capybara"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
17
+ f.match(%r{^(test|spec|features)/})
18
+ end
19
+ spec.bindir = "exe"
20
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_dependency "capybara", "~> 2.13"
24
+ spec.add_development_dependency "bundler", "~> 1.14"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Extracted to separate location to assist in ./bin/run_tests to work.
4
+ module Bunyan
5
+ DEFAULT_ENVIRONMENT = 'prod'.freeze
6
+ DEFAULT_LOG_LEVEL = 'info'.freeze
7
+ AVAILABLE_LOG_LEVELS = %w(debug info warn error fatal).freeze
8
+ DISALLOWED_NETWORK_TRAFFIC_REGEXP = /\.example\.com\//.freeze
9
+ end
@@ -0,0 +1,15 @@
1
+ BunyanVariable = Struct.new(:application_name_under_test, :test_type, :path_to_spec_directory, :environment_under_test)
2
+
3
+ module BunyanVariableExtractor
4
+ # @param path [String] The path to the spec file that is being tested
5
+ # @return [ExampleStruct] An object that responds to #application_name_under_test and #test_type
6
+ # @note If we start nesting our specs, this may need to be revisited.
7
+ def self.call(path:, config:)
8
+ path_to_spec_directory = File.expand_path('~/git/QA_tests/spec/', __FILE__)
9
+ spec_sub_directory = path.sub("#{path_to_spec_directory}/", '').split('/')
10
+ application_name_under_test = spec_sub_directory[0]
11
+ test_type = spec_sub_directory[1]
12
+ environment_under_test = config.fetch('ENVIRONMENT', Bunyan::DEFAULT_ENVIRONMENT)
13
+ BunyanVariable.new(application_name_under_test, test_type, path_to_spec_directory, environment_under_test)
14
+ end
15
+ end
@@ -0,0 +1,3 @@
1
+ module BunyanCapybara
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,228 @@
1
+ require "bunyan_capybara/version"
2
+ require "bunyan_capybara/bunyan_variable_extractor"
3
+ require "bunyan_capybara/bunyan_constants"
4
+
5
+ require "capybara/node/element"
6
+ class Capybara::Node::Element
7
+ # As much as I would like to leverage a module mixin and `super`, I am not able to get this to work
8
+ # Instead I am using an alternative mechanism to `super`:
9
+ # * Get the trigger_method
10
+ # * Define a new trigger method
11
+ # * Bind and call the old trigger method but add additional behavior
12
+ trigger_method = instance_method(:trigger)
13
+ define_method :trigger do |method_name, *args|
14
+ trigger_method.bind(self).call(method_name, *args).tap do |obj|
15
+ Bunyan.current_logger.info(context: "trigger('#{method_name}')", path: @session.current_path, host: Capybara.app_host)
16
+ end
17
+ end
18
+ end
19
+
20
+ module Bunyan
21
+ # Given that we want to send logs to different locations based on application,
22
+ # we need to initialize different loggers. We also don't want to keep adding
23
+ # appenders, so this is a means of instantiating all of those loggers before
24
+ # we run any of the examples.
25
+ #
26
+ # @note Call this method no more than once per spec
27
+ def self.instantiate_all_loggers!(config: ENV)
28
+ raise "You already called instantiate_all_loggers!" if @called
29
+ @called = true
30
+ layout = Logging.layouts.pattern(format_as: :json, date_pattern: "%Y-%m-%d %H:%M:%S.%L")
31
+ Logging.appenders.stdout(layout: layout)
32
+ entries = Dir.glob(File.expand_path('~/git/QA_tests/spec/*', __FILE__))
33
+ entries.each do |entry|
34
+ application_name_under_test = entry.split('/').last
35
+ logger = Logging.logger[application_name_under_test]
36
+ log_filename = File.expand_path("../../../bunyan/logs/#{application_name_under_test}.log", __FILE__)
37
+ logger.add_appenders('stdout', Logging.appenders.file(log_filename, layout: layout))
38
+ logger.level = config.fetch('LOG_LEVEL', DEFAULT_LOG_LEVEL).to_sym
39
+ end
40
+ end
41
+
42
+ def self.start(**kwargs)
43
+ BunyanWrapperWithLogging.new(**kwargs).start
44
+ end
45
+
46
+ # Expose the current logger as a class method; Note this will mean we cannot
47
+ # run our specs in parallel (at least without some other consideration)
48
+ def self.current_logger
49
+ @current_logger
50
+ end
51
+
52
+ # Allow the ExampleLogging.current_logger to be set
53
+ def self.current_logger=(value)
54
+ @current_logger = value
55
+ end
56
+
57
+ def self.reset_current_logger!
58
+ @current_logger = nil
59
+ end
60
+
61
+ def current_logger
62
+ @current_logger
63
+ end
64
+
65
+ # This module injects logging behavior whenever Capybara does the following:
66
+ # * clicks
67
+ # * visits
68
+ # * submits
69
+ module CapybaraInjection
70
+ def click(*args, &block)
71
+ super.tap { log_url_action(context: __method__) }
72
+ end
73
+
74
+ def submit(*args, &block)
75
+ super.tap { log_url_action(context: __method__) }
76
+ end
77
+
78
+ def visit(*arg, &block)
79
+ super.tap { log_url_action(context: __method__) }
80
+ end
81
+
82
+ def trigger(*arg, &block)
83
+ super.tap { log_url_action(context: __method__) }
84
+ end
85
+
86
+ private
87
+
88
+ def log_url_action(context:)
89
+ @current_logger.info(context: context, path: current_path, host: Capybara.app_host)
90
+ end
91
+ end
92
+
93
+ # Responsible for wrapping the testing process within a predicatable logging environment.
94
+ # The wrapper behaves like the underlying logger.
95
+ class BunyanWrapperWithLogging
96
+ extend Forwardable
97
+
98
+ # @return [ExampleVariable]
99
+ attr_reader :example_variable
100
+
101
+ # @!attribute [r] test_type
102
+ # The type of test (e.g. integration or functional) that is being run.
103
+ # @example 'integration'
104
+ # @return [String]
105
+ def_delegator :example_variable, :test_type
106
+
107
+ # @!attribute [r] application_name_under_test
108
+ # This repository tests multiple applications. Each named application is a subdirectory of './spec/'
109
+ # @example 'curate'
110
+ # @return [String]
111
+ def_delegator :example_variable, :application_name_under_test
112
+
113
+ # Used to configure the specifics of this application
114
+ # @example ENV
115
+ # @return [Hash]
116
+ attr_reader :config
117
+
118
+ # The current logger for the given scenario
119
+ # @return [ExampleLogging::CurrentLogger]
120
+ attr_reader :current_logger
121
+
122
+ # The Environment in which we are running our tests against
123
+ # @example 'prod'
124
+ # @return [String]
125
+ attr_reader :environment_under_test
126
+
127
+ # The Rspec example that will be run
128
+ # @return [RSpec::Core::Example]
129
+ attr_reader :example
130
+
131
+ # Where can we find the global spec_helper.rb file?
132
+ # @return [String]
133
+ attr_reader :path_to_spec_directory
134
+
135
+ # The context in which the tests are actually run. From here we can make assertions/expections.
136
+ # @return [#expect]
137
+ attr_reader :test_handler
138
+
139
+ # The name of the driver in which the scenario is run.
140
+ # @example :poltergeist
141
+ # @return [Symbol]
142
+ attr_reader :capybara_driver_name
143
+
144
+ def initialize(example:, test_handler:, config: ENV)
145
+ @example = example
146
+ @config = config
147
+ @test_handler = test_handler
148
+ @environment_under_test = config.fetch('ENVIRONMENT', DEFAULT_ENVIRONMENT)
149
+ @path_to_spec_directory = File.expand_path('../../', __FILE__)
150
+ initialize_example_variables!
151
+ @current_logger = Logging.logger[application_name_under_test]
152
+ end
153
+
154
+ # Responsible for logging the start of a test
155
+ # @return [ExampleLogging::ExampleWrapper]
156
+ def start
157
+ info(context: "BEGIN example", example: example.full_description, location: example.location)
158
+ self
159
+ end
160
+
161
+ # Responsible for consistent logging of the end steps of a test
162
+ # @return [ExampleLogging::ExampleWrapper]
163
+ def stop
164
+ info(context: "END example", example: example.full_description, location: example.location)
165
+ end
166
+
167
+ public
168
+
169
+ # Log a "debug" level event
170
+ # @param context [#to_s] The context of what is being logged
171
+ # @param kwargs [Hash] The other key/value pair information to log
172
+ # @yield If a block is given, it will log the begining, then yield, then log the ending
173
+ def debug(context:, **kwargs, &block)
174
+ log(severity: __method__, context: context, **kwargs, &block)
175
+ end
176
+
177
+ # Log an "info" level event
178
+ # @param context [#to_s] The context of what is being logged
179
+ # @param kwargs [Hash] The other key/value pair information to log
180
+ # @yield If a block is given, it will log the begining, then yield, then log the ending
181
+ def info(context:, **kwargs, &block)
182
+ log(severity: __method__, context: context, **kwargs, &block)
183
+ end
184
+
185
+ # Log a "warn" level event
186
+ # @param context [#to_s] The context of what is being logged
187
+ # @param kwargs [Hash] The other key/value pair information to log
188
+ # @yield If a block is given, it will log the begining, then yield, then log the ending
189
+ def warn(context:, **kwargs, &block)
190
+ log(severity: __method__, context: context, **kwargs, &block)
191
+ end
192
+
193
+ # Log a "error" level event
194
+ # @param context [#to_s] The context of what is being logged
195
+ # @param kwargs [Hash] The other key/value pair information to log
196
+ # @yield If a block is given, it will log the begining, then yield, then log the ending
197
+ def error(context:, **kwargs, &block)
198
+ log(severity: __method__, context: context, **kwargs, &block)
199
+ end
200
+
201
+ # Log a "fatal" level event
202
+ # @param context [#to_s] The context of what is being logged
203
+ # @param kwargs [Hash] The other key/value pair information to log
204
+ # @yield If a block is given, it will log the begining, then yield, then log the ending
205
+ def fatal(context:, **kwargs, &block)
206
+ log(severity: __method__, context: context, **kwargs, &block)
207
+ end
208
+
209
+ private
210
+
211
+ def log(severity:, context:, **kwargs)
212
+ message = ""
213
+ kwargs.each { |key, value| message += %(#{key}: #{value.inspect}\t) }
214
+ if block_given?
215
+ @current_logger.public_send(severity, %(test_type: #{test_type}\t runID: #{RunIdentifier.get}\t context: "BEGIN #{context}\t#{message}).strip)
216
+ yield
217
+ @current_logger.public_send(severity, %(test_type: #{test_type}\t runID: #{RunIdentifier.get}\t context: "END #{context}\t#{message}).strip)
218
+ else
219
+ @current_logger.public_send(severity, %(test_type: #{test_type}\t runID: #{RunIdentifier.get}\t context: "#{context}"\t#{message}).strip)
220
+ end
221
+ end
222
+
223
+ def initialize_example_variables!
224
+ @example_variable = BunyanVariableExtractor.call(path: @example.metadata.fetch(:absolute_file_path), config: config)
225
+ end
226
+ end
227
+ private_constant :BunyanWrapperWithLogging
228
+ end
metadata ADDED
@@ -0,0 +1,113 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: bunyan_capybara
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Max Hallwachs
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-09-22 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: capybara
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.13'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.14'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.14'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: adds loggin capabilities
70
+ email:
71
+ - mhallwac@nd.edu
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - Gemfile
80
+ - LICENSE
81
+ - README.md
82
+ - Rakefile
83
+ - bin/console
84
+ - bin/setup
85
+ - bunyan_capybara.gemspec
86
+ - lib/bunyan_capybara.rb
87
+ - lib/bunyan_capybara/bunyan_constants.rb
88
+ - lib/bunyan_capybara/bunyan_variable_extractor.rb
89
+ - lib/bunyan_capybara/version.rb
90
+ homepage: https://github.com/ndlib/bunyan_capybara
91
+ licenses: []
92
+ metadata: {}
93
+ post_install_message:
94
+ rdoc_options: []
95
+ require_paths:
96
+ - lib
97
+ required_ruby_version: !ruby/object:Gem::Requirement
98
+ requirements:
99
+ - - ">="
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ required_rubygems_version: !ruby/object:Gem::Requirement
103
+ requirements:
104
+ - - ">="
105
+ - !ruby/object:Gem::Version
106
+ version: '0'
107
+ requirements: []
108
+ rubyforge_project:
109
+ rubygems_version: 2.6.8
110
+ signing_key:
111
+ specification_version: 4
112
+ summary: Logger
113
+ test_files: []