startback 0.7.1 → 0.7.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/startback.rb +2 -0
- data/lib/startback/audit.rb +1 -0
- data/lib/startback/audit/prometheus.rb +94 -0
- data/lib/startback/ext/date_time.rb +1 -1
- data/lib/startback/ext/time.rb +1 -1
- data/lib/startback/operation.rb +8 -0
- data/lib/startback/version.rb +1 -1
- data/lib/startback/web/api.rb +15 -2
- data/lib/startback/web/prometheus.rb +16 -0
- data/spec/rspec-unit.xml +97 -95
- data/spec/unit/audit/test_prometheus.rb +72 -0
- data/tasks/test.rake +1 -0
- metadata +25 -8
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 471e48fd8b83e7f9b14eb4bbeac3bceb8156b32cc4a33abe97256819f3779f7b
|
4
|
+
data.tar.gz: c2570266bfce1d823f438276cfb435a948e87fd692f328d93b581b4c28f08b0b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b401a5987fff97c5f62fc8928d5f988581f10173b9d9222c2846774c6e114c44e08f873afa2b6ebac70f71ada966213f4ed46c965d6fe75deda391fb56d8c88d
|
7
|
+
data.tar.gz: 7fa4cf724eb3a051fc5d3744b2ae5d00c19d553e0d7f044938f8582b75ea0be93b56a364fdfd44b3ed6c6e130a52dd3059c2e08f7a7aad18560ed156089bffa0
|
data/lib/startback.rb
CHANGED
@@ -5,6 +5,7 @@ require 'logger'
|
|
5
5
|
require 'path'
|
6
6
|
require 'ostruct'
|
7
7
|
require 'benchmark'
|
8
|
+
|
8
9
|
# Provides a reusable backend framework for backend components written
|
9
10
|
# in ruby.
|
10
11
|
#
|
@@ -27,6 +28,7 @@ module Startback
|
|
27
28
|
end
|
28
29
|
end
|
29
30
|
|
31
|
+
require_relative 'startback/version'
|
30
32
|
require_relative 'startback/ext'
|
31
33
|
require_relative 'startback/errors'
|
32
34
|
require_relative 'startback/support'
|
data/lib/startback/audit.rb
CHANGED
@@ -0,0 +1,94 @@
|
|
1
|
+
require 'prometheus/client'
|
2
|
+
|
3
|
+
module Startback
|
4
|
+
module Audit
|
5
|
+
#
|
6
|
+
# Prometheus exporter abstraction, that can be registered as an around
|
7
|
+
# hook on OperationRunner and as a prometheus client on Context instances.
|
8
|
+
#
|
9
|
+
# The exporter uses the ruby client for prometheus to expose metrics regarding Operation runs.
|
10
|
+
#
|
11
|
+
# The following metrics are exported:
|
12
|
+
#
|
13
|
+
# A counter 'operation_errors' (failed runs)
|
14
|
+
# A histogram 'operation_calls'
|
15
|
+
#
|
16
|
+
# All these metrics use the following labels
|
17
|
+
# - operation : class name of the operation executed
|
18
|
+
#
|
19
|
+
# Given that this Exporter is intended to be used as around hook on an
|
20
|
+
# `OperationRunner`, operations that fail at construction time will not be
|
21
|
+
# exported at all, since they can't be ran in the first place. This may lead
|
22
|
+
# to metrics not containing important errors cases if operations check their
|
23
|
+
# input at construction time.
|
24
|
+
#
|
25
|
+
class Prometheus
|
26
|
+
|
27
|
+
def initialize(options = {})
|
28
|
+
@prefix = options[:prefix] || "startback"
|
29
|
+
@options = options
|
30
|
+
@registry = ::Prometheus::Client.registry
|
31
|
+
all_labels = [:operation, :startback_version] + option_labels.keys
|
32
|
+
@errors = @registry.counter(
|
33
|
+
:"#{prefix}_operation_errors",
|
34
|
+
docstring: 'A counter of operation errors',
|
35
|
+
labels: all_labels)
|
36
|
+
@calls = @registry.histogram(
|
37
|
+
:"#{prefix}_operation_calls",
|
38
|
+
docstring: 'A histogram of operation latency',
|
39
|
+
labels: all_labels)
|
40
|
+
end
|
41
|
+
attr_reader :registry, :calls, :errors, :options, :prefix
|
42
|
+
|
43
|
+
def call(runner, op)
|
44
|
+
name = op_name(op)
|
45
|
+
result = nil
|
46
|
+
time = Benchmark.realtime{
|
47
|
+
result = yield
|
48
|
+
}
|
49
|
+
ignore_safely {
|
50
|
+
@calls.observe(time, labels: get_labels(name))
|
51
|
+
}
|
52
|
+
result
|
53
|
+
rescue => ex
|
54
|
+
ignore_safely {
|
55
|
+
@errors.increment(labels: get_labels(name))
|
56
|
+
}
|
57
|
+
raise
|
58
|
+
end
|
59
|
+
|
60
|
+
protected
|
61
|
+
|
62
|
+
def ignore_safely
|
63
|
+
yield
|
64
|
+
rescue => ex
|
65
|
+
puts ex.class.to_s + "\n" + ex.message + "\n" + ex.backtrace.join("\n")
|
66
|
+
nil
|
67
|
+
end
|
68
|
+
|
69
|
+
def get_labels(op_name)
|
70
|
+
option_labels.merge({
|
71
|
+
operation: op_name,
|
72
|
+
startback_version: version
|
73
|
+
})
|
74
|
+
end
|
75
|
+
|
76
|
+
def option_labels
|
77
|
+
@options[:labels] || {}
|
78
|
+
end
|
79
|
+
|
80
|
+
def version
|
81
|
+
Startback::VERSION
|
82
|
+
end
|
83
|
+
|
84
|
+
def op_name(op)
|
85
|
+
case op
|
86
|
+
when String then op
|
87
|
+
when Class then op.name
|
88
|
+
else op.class.name
|
89
|
+
end
|
90
|
+
end
|
91
|
+
|
92
|
+
end # class Prometheus
|
93
|
+
end # module Audit
|
94
|
+
end # module Startback
|
data/lib/startback/ext/time.rb
CHANGED
data/lib/startback/operation.rb
CHANGED
@@ -52,6 +52,14 @@ module Startback
|
|
52
52
|
super || (world && world.has_key?(name))
|
53
53
|
end
|
54
54
|
|
55
|
+
def with_context(ctx = nil)
|
56
|
+
old_world = self.world
|
57
|
+
self.world = self.world.merge(context: ctx || old_world.context.dup)
|
58
|
+
result = ctx ? yield : yield(self.world.context)
|
59
|
+
self.world = old_world
|
60
|
+
result
|
61
|
+
end
|
62
|
+
|
55
63
|
protected
|
56
64
|
|
57
65
|
def operation_world(op)
|
data/lib/startback/version.rb
CHANGED
data/lib/startback/web/api.rb
CHANGED
@@ -17,6 +17,15 @@ module Startback
|
|
17
17
|
env[Startback::Context::Middleware::RACK_ENV_KEY]
|
18
18
|
end
|
19
19
|
|
20
|
+
def with_context(ctx = nil)
|
21
|
+
old_context = self.context
|
22
|
+
new_context = ctx || self.context.dup
|
23
|
+
env[Startback::Context::Middleware::RACK_ENV_KEY] = new_context
|
24
|
+
result = ctx ? yield : yield(new_context)
|
25
|
+
env[Startback::Context::Middleware::RACK_ENV_KEY] = old_context
|
26
|
+
result
|
27
|
+
end
|
28
|
+
|
20
29
|
###
|
21
30
|
### Facade over third party tools
|
22
31
|
###
|
@@ -58,13 +67,17 @@ module Startback
|
|
58
67
|
[ 204, {}, [] ]
|
59
68
|
end
|
60
69
|
|
61
|
-
def serve(entity_description, entity, ct =
|
70
|
+
def serve(entity_description, entity, ct = nil)
|
62
71
|
if entity.nil?
|
63
72
|
status 404
|
64
73
|
content_type :json
|
65
74
|
{ description: "#{entity_description} not found" }.to_json
|
66
|
-
|
75
|
+
elsif entity.respond_to?(:to_dto)
|
76
|
+
ct, body = entity.to_dto(context).to(env['HTTP_ACCEPT'], ct)
|
67
77
|
content_type ct
|
78
|
+
body
|
79
|
+
else
|
80
|
+
content_type ct || "application/json"
|
68
81
|
entity.to_json
|
69
82
|
end
|
70
83
|
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'prometheus/middleware/exporter'
|
2
|
+
module Startback
|
3
|
+
module Web
|
4
|
+
#
|
5
|
+
# Can be used to expose the prometheus metrics inside a Startback
|
6
|
+
# application.
|
7
|
+
#
|
8
|
+
# Example:
|
9
|
+
#
|
10
|
+
# use Startback::Web::Prometheus
|
11
|
+
#
|
12
|
+
class Prometheus < Prometheus::Middleware::Exporter
|
13
|
+
|
14
|
+
end # class Prometheus
|
15
|
+
end # module Web
|
16
|
+
end # module Startback
|
data/spec/rspec-unit.xml
CHANGED
@@ -1,100 +1,102 @@
|
|
1
1
|
<?xml version="1.0" encoding="UTF-8"?>
|
2
|
-
<testsuite name="rspec" tests="
|
2
|
+
<testsuite name="rspec" tests="96" skipped="0" failures="0" errors="0" time="3.326515" timestamp="2020-12-11T18:21:32+01:00" hostname="Cassiopeia.local">
|
3
3
|
<properties>
|
4
|
-
<property name="seed" value="
|
4
|
+
<property name="seed" value="36306"/>
|
5
5
|
</properties>
|
6
|
-
<testcase classname="spec.unit.audit.
|
7
|
-
<testcase classname="spec.unit.audit.
|
8
|
-
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_data uses
|
9
|
-
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_data
|
10
|
-
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_data
|
11
|
-
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_data
|
12
|
-
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer
|
13
|
-
<testcase classname="spec.unit.
|
14
|
-
<testcase classname="spec.unit.
|
15
|
-
<testcase classname="spec.unit.bus.memory.test_async" name="Startback::Bus::Memory
|
16
|
-
<testcase classname="spec.unit.bus.memory.
|
17
|
-
<testcase classname="spec.unit.bus.memory.
|
18
|
-
<testcase classname="spec.unit.bus.memory.test_sync" name="Startback::Bus::Memory
|
19
|
-
<testcase classname="spec.unit.
|
20
|
-
<testcase classname="spec.unit.
|
21
|
-
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache default_ttl
|
22
|
-
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache
|
23
|
-
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache
|
24
|
-
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache
|
25
|
-
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache
|
26
|
-
<testcase classname="spec.unit.
|
27
|
-
<testcase classname="spec.unit.
|
28
|
-
<testcase classname="spec.unit.context.test_abstraction_factory" name="Startback::Context factor is
|
29
|
-
<testcase classname="spec.unit.context.test_abstraction_factory" name="Startback::Context factor is
|
30
|
-
<testcase classname="spec.unit.context.
|
31
|
-
<testcase classname="spec.unit.context.
|
32
|
-
<testcase classname="spec.unit.context.
|
33
|
-
<testcase classname="spec.unit.context.
|
34
|
-
<testcase classname="spec.unit.context.test_h_factory" name="Startback::Context h information contract has a
|
35
|
-
<testcase classname="spec.unit.context.test_h_factory" name="Startback::Context h information contract
|
36
|
-
<testcase classname="spec.unit.context.
|
37
|
-
<testcase classname="spec.unit.context.
|
38
|
-
<testcase classname="spec.unit.
|
39
|
-
<testcase classname="spec.unit.
|
40
|
-
<testcase classname="spec.unit.support.hooks.
|
41
|
-
<testcase classname="spec.unit.support.hooks.
|
42
|
-
<testcase classname="spec.unit.support.
|
43
|
-
<testcase classname="spec.unit.support.
|
44
|
-
<testcase classname="spec.unit.support.operation_runner.test_around_run" name="Startback::Support::OperationRunner around_run the
|
45
|
-
<testcase classname="spec.unit.support.operation_runner.test_around_run" name="Startback::Support::OperationRunner around_run the around feature
|
46
|
-
<testcase classname="spec.unit.support.operation_runner.
|
47
|
-
<testcase classname="spec.unit.support.
|
48
|
-
<testcase classname="spec.unit.support.
|
49
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness
|
50
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness
|
51
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness
|
52
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness try_max_times
|
53
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness
|
54
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness
|
55
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with
|
56
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with
|
57
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with
|
58
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with a string
|
59
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with a
|
60
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with a
|
61
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with
|
62
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args
|
63
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness
|
64
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness
|
65
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness logger_for works on
|
66
|
-
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness logger_for works on
|
67
|
-
<testcase classname="spec.unit.
|
68
|
-
<testcase classname="spec.unit.
|
69
|
-
<testcase classname="spec.unit.test_event" name="Startback::Event
|
70
|
-
<testcase classname="spec.unit.test_event" name="Startback::Event the json information contract has a
|
71
|
-
<testcase classname="spec.unit.test_event" name="Startback::Event the json information contract
|
72
|
-
<testcase classname="spec.unit.test_event" name="Startback::Event the json information contract
|
73
|
-
<testcase classname="spec.unit.
|
74
|
-
<testcase classname="spec.unit.
|
75
|
-
<testcase classname="spec.unit.test_operation" name="Startback::Operation
|
76
|
-
<testcase classname="spec.unit.test_operation" name="Startback::Operation::MultiOperation
|
77
|
-
<testcase classname="spec.unit.
|
78
|
-
<testcase classname="spec.unit.
|
79
|
-
<testcase classname="spec.unit.
|
80
|
-
<testcase classname="spec.unit.web.test_auto_caching" name="Startback::Web::AutoCaching when
|
81
|
-
<testcase classname="spec.unit.web.test_auto_caching" name="Startback::Web::AutoCaching when
|
82
|
-
<testcase classname="spec.unit.web.test_auto_caching" name="Startback::Web::AutoCaching when
|
83
|
-
<testcase classname="spec.unit.web.
|
84
|
-
<testcase classname="spec.unit.web.
|
85
|
-
<testcase classname="spec.unit.web.
|
6
|
+
<testcase classname="spec.unit.audit.test_prometheus" name="Startback::Audit::Prometheus The ideal case runs the operation" file="./spec/unit/audit/test_prometheus.rb" time="0.006429"></testcase>
|
7
|
+
<testcase classname="spec.unit.audit.test_prometheus" name="Startback::Audit::Prometheus The exceptional case let errors bubble up" file="./spec/unit/audit/test_prometheus.rb" time="0.001308"></testcase>
|
8
|
+
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_data uses to_trail in priority if provided" file="./spec/unit/audit/test_trailer.rb" time="0.000190"></testcase>
|
9
|
+
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_data uses input then" file="./spec/unit/audit/test_trailer.rb" time="0.000113"></testcase>
|
10
|
+
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_data uses request then" file="./spec/unit/audit/test_trailer.rb" time="0.000106"></testcase>
|
11
|
+
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_data applies default blacklists for security reasons" file="./spec/unit/audit/test_trailer.rb" time="0.000109"></testcase>
|
12
|
+
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_data applies default blacklists to data arrays too" file="./spec/unit/audit/test_trailer.rb" time="0.000107"></testcase>
|
13
|
+
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_data uses the stop words provided at construction" file="./spec/unit/audit/test_trailer.rb" time="0.000103"></testcase>
|
14
|
+
<testcase classname="spec.unit.audit.test_trailer" name="Startback::Audit::Trailer op_context applies default blacklists for security reasons" file="./spec/unit/audit/test_trailer.rb" time="0.000107"></testcase>
|
15
|
+
<testcase classname="spec.unit.bus.memory.test_async" name="Startback::Bus::Memory allows emiting an receiving" file="./spec/unit/bus/memory/test_async.rb" time="0.000650"></testcase>
|
16
|
+
<testcase classname="spec.unit.bus.memory.test_async" name="Startback::Bus::Memory allows mixin Symbol vs. String for event type" file="./spec/unit/bus/memory/test_async.rb" time="0.000105"></testcase>
|
17
|
+
<testcase classname="spec.unit.bus.memory.test_async" name="Startback::Bus::Memory does not raise errors synchronously" file="./spec/unit/bus/memory/test_async.rb" time="0.000760"></testcase>
|
18
|
+
<testcase classname="spec.unit.bus.memory.test_sync" name="Startback::Bus::Memory allows emiting an receiving" file="./spec/unit/bus/memory/test_sync.rb" time="0.000069"></testcase>
|
19
|
+
<testcase classname="spec.unit.bus.memory.test_sync" name="Startback::Bus::Memory allows mixin Symbol vs. String for event type" file="./spec/unit/bus/memory/test_sync.rb" time="0.000054"></testcase>
|
20
|
+
<testcase classname="spec.unit.bus.memory.test_sync" name="Startback::Bus::Memory raises emit errors synchronously" file="./spec/unit/bus/memory/test_sync.rb" time="0.000062"></testcase>
|
21
|
+
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache default_ttl has a default ttl of one hour" file="./spec/unit/caching/test_entity_cache.rb" time="0.000046"></testcase>
|
22
|
+
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache default_ttl allows overriding it" file="./spec/unit/caching/test_entity_cache.rb" time="0.000038"></testcase>
|
23
|
+
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache default_ttl is accessible as default_caching_options on the instance" file="./spec/unit/caching/test_entity_cache.rb" time="0.000048"></testcase>
|
24
|
+
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache get yields to load_raw_data only once with the short key" file="./spec/unit/caching/test_entity_cache.rb" time="0.000102"></testcase>
|
25
|
+
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache primary_key allows using candidate keys" file="./spec/unit/caching/test_entity_cache.rb" time="0.000084"></testcase>
|
26
|
+
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache invalidate strips the key on the store, yielding a cache miss" file="./spec/unit/caching/test_entity_cache.rb" time="0.000104"></testcase>
|
27
|
+
<testcase classname="spec.unit.caching.test_entity_cache" name="Startback::Caching::EntityCache valid? override yields to load_raw_data only once with the extend key" file="./spec/unit/caching/test_entity_cache.rb" time="0.000146"></testcase>
|
28
|
+
<testcase classname="spec.unit.context.test_abstraction_factory" name="Startback::Context factor is a factory for other context-related abstractions" file="./spec/unit/context/test_abstraction_factory.rb" time="0.000690"></testcase>
|
29
|
+
<testcase classname="spec.unit.context.test_abstraction_factory" name="Startback::Context factor is takes cares of abstraction arguments" file="./spec/unit/context/test_abstraction_factory.rb" time="0.000063"></testcase>
|
30
|
+
<testcase classname="spec.unit.context.test_abstraction_factory" name="Startback::Context factor is caches even in presence ofabstraction arguments" file="./spec/unit/context/test_abstraction_factory.rb" time="0.000052"></testcase>
|
31
|
+
<testcase classname="spec.unit.context.test_abstraction_factory" name="Startback::Context factor is distinguishes different abstraction arguments" file="./spec/unit/context/test_abstraction_factory.rb" time="0.000052"></testcase>
|
32
|
+
<testcase classname="spec.unit.context.test_dup" name="Startback::Context dup yields a dup of the original context" file="./spec/unit/context/test_dup.rb" time="0.000062"></testcase>
|
33
|
+
<testcase classname="spec.unit.context.test_dup" name="Startback::Context dup cleans all factored cache" file="./spec/unit/context/test_dup.rb" time="0.000057"></testcase>
|
34
|
+
<testcase classname="spec.unit.context.test_h_factory" name="Startback::Context h information contract has a to_json that dumps it" file="./spec/unit/context/test_h_factory.rb" time="0.000087"></testcase>
|
35
|
+
<testcase classname="spec.unit.context.test_h_factory" name="Startback::Context h information contract allows installing factories" file="./spec/unit/context/test_h_factory.rb" time="0.001692"></testcase>
|
36
|
+
<testcase classname="spec.unit.context.test_h_factory" name="Startback::Context h information contract has a `to_h` information contract that works as expected" file="./spec/unit/context/test_h_factory.rb" time="0.000091"></testcase>
|
37
|
+
<testcase classname="spec.unit.context.test_h_factory" name="Startback::Context h information contract has a `h` information contract that works as expected" file="./spec/unit/context/test_h_factory.rb" time="0.000049"></testcase>
|
38
|
+
<testcase classname="spec.unit.context.test_middleware" name="Startback::Context::Middleware when used without option sets the default context class" file="./spec/unit/context/test_middleware.rb" time="0.003715"></testcase>
|
39
|
+
<testcase classname="spec.unit.context.test_middleware" name="Startback::Context::Middleware when specifying the context class sets the default context class" file="./spec/unit/context/test_middleware.rb" time="0.000167"></testcase>
|
40
|
+
<testcase classname="spec.unit.support.hooks.test_after_hook" name="Startback::Support::Hooks after_xxx works as expected" file="./spec/unit/support/hooks/test_after_hook.rb" time="0.000055"></testcase>
|
41
|
+
<testcase classname="spec.unit.support.hooks.test_after_hook" name="Startback::Support::Hooks after_xxx works as expected on subclass" file="./spec/unit/support/hooks/test_after_hook.rb" time="0.000051"></testcase>
|
42
|
+
<testcase classname="spec.unit.support.hooks.test_before_hook" name="Startback::Support::Hooks before_xxx works as expected" file="./spec/unit/support/hooks/test_before_hook.rb" time="0.000073"></testcase>
|
43
|
+
<testcase classname="spec.unit.support.hooks.test_before_hook" name="Startback::Support::Hooks before_xxx works as expected on subclass" file="./spec/unit/support/hooks/test_before_hook.rb" time="0.000070"></testcase>
|
44
|
+
<testcase classname="spec.unit.support.operation_runner.test_around_run" name="Startback::Support::OperationRunner around_run the simplest contract lets run an operation with world bound" file="./spec/unit/support/operation_runner/test_around_run.rb" time="0.000085"></testcase>
|
45
|
+
<testcase classname="spec.unit.support.operation_runner.test_around_run" name="Startback::Support::OperationRunner around_run the around feature calls the around before the operation itself" file="./spec/unit/support/operation_runner/test_around_run.rb" time="0.000108"></testcase>
|
46
|
+
<testcase classname="spec.unit.support.operation_runner.test_around_run" name="Startback::Support::OperationRunner around_run the around feature with a class calls the proc with expected parameters" file="./spec/unit/support/operation_runner/test_around_run.rb" time="0.000066"></testcase>
|
47
|
+
<testcase classname="spec.unit.support.operation_runner.test_around_run" name="Startback::Support::OperationRunner around_run the around feature with a subclass executes all hooks" file="./spec/unit/support/operation_runner/test_around_run.rb" time="0.000072"></testcase>
|
48
|
+
<testcase classname="spec.unit.support.operation_runner.test_before_after_call" name="Startback::Support::OperationRunner before_call runs before the around hooks" file="./spec/unit/support/operation_runner/test_before_after_call.rb" time="0.000072"></testcase>
|
49
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness monitor works" file="./spec/unit/support/test_robusteness.rb" time="0.000077"></testcase>
|
50
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness stop_errors works and logs the error" file="./spec/unit/support/test_robusteness.rb" time="0.000125"></testcase>
|
51
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness stop_errors returns the result if no error" file="./spec/unit/support/test_robusteness.rb" time="0.000081"></testcase>
|
52
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness try_max_times fails if n errors are seen" file="./spec/unit/support/test_robusteness.rb" time="1.004431"></testcase>
|
53
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness try_max_times suceeds if an attemps succeeds" file="./spec/unit/support/test_robusteness.rb" time="1.003857"></testcase>
|
54
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness try_max_times suceeds if first attemps succeeds" file="./spec/unit/support/test_robusteness.rb" time="0.000096"></testcase>
|
55
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with full op and no context" file="./spec/unit/support/test_robusteness.rb" time="0.000085"></testcase>
|
56
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with an string and a method name" file="./spec/unit/support/test_robusteness.rb" time="0.000048"></testcase>
|
57
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with an string, a method name, and a message" file="./spec/unit/support/test_robusteness.rb" time="0.000085"></testcase>
|
58
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with a string only" file="./spec/unit/support/test_robusteness.rb" time="0.000045"></testcase>
|
59
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with a string and a context with logger" file="./spec/unit/support/test_robusteness.rb" time="0.000053"></testcase>
|
60
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with a string and an extra hash" file="./spec/unit/support/test_robusteness.rb" time="0.000046"></testcase>
|
61
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with a module and method" file="./spec/unit/support/test_robusteness.rb" time="0.000048"></testcase>
|
62
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with a class and method" file="./spec/unit/support/test_robusteness.rb" time="0.000054"></testcase>
|
63
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args works fine with an instance and method" file="./spec/unit/support/test_robusteness.rb" time="0.000048"></testcase>
|
64
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness parse_args when a hash is passed as last arg" file="./spec/unit/support/test_robusteness.rb" time="0.000079"></testcase>
|
65
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness logger_for works on a logger" file="./spec/unit/support/test_robusteness.rb" time="0.000047"></testcase>
|
66
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness logger_for works on a Context responding to logger" file="./spec/unit/support/test_robusteness.rb" time="0.000051"></testcase>
|
67
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness logger_for works on an object having a Context responding to logger" file="./spec/unit/support/test_robusteness.rb" time="0.000063"></testcase>
|
68
|
+
<testcase classname="spec.unit.support.test_robusteness" name="Startback::Support::Robustness logger_for works on an object having a Context but no logger" file="./spec/unit/support/test_robusteness.rb" time="0.000050"></testcase>
|
69
|
+
<testcase classname="spec.unit.test_event" name="Startback::Event presents an ostruct on top of its data" file="./spec/unit/test_event.rb" time="0.000087"></testcase>
|
70
|
+
<testcase classname="spec.unit.test_event" name="Startback::Event the json information contract has a to_json method that works as expected" file="./spec/unit/test_event.rb" time="0.000058"></testcase>
|
71
|
+
<testcase classname="spec.unit.test_event" name="Startback::Event the json information contract has a to_json that dumps the context if any" file="./spec/unit/test_event.rb" time="0.000057"></testcase>
|
72
|
+
<testcase classname="spec.unit.test_event" name="Startback::Event the json information contract has a json class method that works as expected" file="./spec/unit/test_event.rb" time="0.000111"></testcase>
|
73
|
+
<testcase classname="spec.unit.test_event" name="Startback::Event the json information contract accepts an explicit context in the world" file="./spec/unit/test_event.rb" time="0.000047"></testcase>
|
74
|
+
<testcase classname="spec.unit.test_event" name="Startback::Event the json information contract accepts an context factory in the world" file="./spec/unit/test_event.rb" time="0.000051"></testcase>
|
75
|
+
<testcase classname="spec.unit.test_operation" name="Startback::Operation can be bound, which returns a new operation" file="./spec/unit/test_operation.rb" time="0.000049"></testcase>
|
76
|
+
<testcase classname="spec.unit.test_operation" name="Startback::Operation::MultiOperation lets chain with +" file="./spec/unit/test_operation.rb" time="0.000054"></testcase>
|
77
|
+
<testcase classname="spec.unit.test_operation" name="Startback::Operation::MultiOperation calls and collects the result on call" file="./spec/unit/test_operation.rb" time="0.000077"></testcase>
|
78
|
+
<testcase classname="spec.unit.test_operation" name="Startback::Operation::MultiOperation binds every sub operation recursively" file="./spec/unit/test_operation.rb" time="0.000044"></testcase>
|
79
|
+
<testcase classname="spec.unit.test_support" name="Startback::Support deep_merge works as expected" file="./spec/unit/test_support.rb" time="0.000048"></testcase>
|
80
|
+
<testcase classname="spec.unit.web.test_auto_caching" name="Startback::Web::AutoCaching when used without options sets the development Cache-Control since this is a test" file="./spec/unit/web/test_auto_caching.rb" time="0.000195"></testcase>
|
81
|
+
<testcase classname="spec.unit.web.test_auto_caching" name="Startback::Web::AutoCaching when forcing production sets the production Cache-Control" file="./spec/unit/web/test_auto_caching.rb" time="0.000125"></testcase>
|
82
|
+
<testcase classname="spec.unit.web.test_auto_caching" name="Startback::Web::AutoCaching when forcing development headers sets the production Cache-Control" file="./spec/unit/web/test_auto_caching.rb" time="0.000160"></testcase>
|
83
|
+
<testcase classname="spec.unit.web.test_auto_caching" name="Startback::Web::AutoCaching when setting the Cache-Control header only sets the production Cache-Control" file="./spec/unit/web/test_auto_caching.rb" time="0.000145"></testcase>
|
84
|
+
<testcase classname="spec.unit.web.test_auto_caching" name="Startback::Web::AutoCaching when a Cache-Control header is already set by the app sets the production Cache-Control" file="./spec/unit/web/test_auto_caching.rb" time="0.000123"></testcase>
|
85
|
+
<testcase classname="spec.unit.web.test_catch_all" name="Startback::Web::CatchAll when used without context returns a 500 with json explanation" file="./spec/unit/web/test_catch_all.rb" time="0.001269"></testcase>
|
86
|
+
<testcase classname="spec.unit.web.test_catch_all" name="Startback::Web::CatchAll when used with a context providing an error handler returns a 500 with json explanation" file="./spec/unit/web/test_catch_all.rb" time="0.000196"></testcase>
|
87
|
+
<testcase classname="spec.unit.web.test_cors_headers" name="Startback::Web::CorsHeaders when used without options sets the CORS headers to default values" file="./spec/unit/web/test_cors_headers.rb" time="0.000146"></testcase>
|
86
88
|
<testcase classname="spec.unit.web.test_cors_headers" name="Startback::Web::CorsHeaders when used without options strips everything when option" file="./spec/unit/web/test_cors_headers.rb" time="0.000163"></testcase>
|
87
|
-
<testcase classname="spec.unit.web.test_cors_headers" name="Startback::Web::CorsHeaders when used with the :bounce option sets the CORS Origin header to the caller" file="./spec/unit/web/test_cors_headers.rb" time="0.
|
88
|
-
<testcase classname="spec.unit.web.test_cors_headers" name="Startback::Web::CorsHeaders when overriding a header sets the CORS Origin header to the caller" file="./spec/unit/web/test_cors_headers.rb" time="0.
|
89
|
-
<testcase classname="spec.unit.web.test_cors_headers" name="Startback::Web::CorsHeaders when the app sets specific headers does not override them" file="./spec/unit/web/test_cors_headers.rb" time="0.
|
90
|
-
<testcase classname="spec.unit.web.test_healthcheck" name="Startback::Web::HealthCheck when used without a block and no failure returns a 204 when ok" file="./spec/unit/web/test_healthcheck.rb" time="0.
|
91
|
-
<testcase classname="spec.unit.web.test_healthcheck" name="Startback::Web::HealthCheck when used without a block a failure raises when ko" file="./spec/unit/web/test_healthcheck.rb" time="0.
|
92
|
-
<testcase classname="spec.unit.web.test_healthcheck" name="Startback::Web::HealthCheck when used with a block returning a debug message returns a 200 with plain text message" file="./spec/unit/web/test_healthcheck.rb" time="0.
|
93
|
-
<testcase classname="spec.unit.web.test_healthcheck" name="Startback::Web::HealthCheck when used with a block raising an exception re-raises it" file="./spec/unit/web/test_healthcheck.rb" time="0.
|
94
|
-
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when used as an app works as expected" file="./spec/unit/web/test_magic_assets.rb" time="
|
95
|
-
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when used as an app delegates a [] call to sprockets" file="./spec/unit/web/test_magic_assets.rb" time="
|
96
|
-
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when used as an app returns a 404 on unknown" file="./spec/unit/web/test_magic_assets.rb" time="0.
|
97
|
-
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when used as a middleware lets unrelated things pass" file="./spec/unit/web/test_magic_assets.rb" time="0.
|
98
|
-
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when used as a middleware serves the assets under the chosen path" file="./spec/unit/web/test_magic_assets.rb" time="
|
99
|
-
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when registering the NgHtmlTransformer works as expected" file="./spec/unit/web/test_magic_assets.rb" time="
|
89
|
+
<testcase classname="spec.unit.web.test_cors_headers" name="Startback::Web::CorsHeaders when used with the :bounce option sets the CORS Origin header to the caller" file="./spec/unit/web/test_cors_headers.rb" time="0.000136"></testcase>
|
90
|
+
<testcase classname="spec.unit.web.test_cors_headers" name="Startback::Web::CorsHeaders when overriding a header sets the CORS Origin header to the caller" file="./spec/unit/web/test_cors_headers.rb" time="0.000134"></testcase>
|
91
|
+
<testcase classname="spec.unit.web.test_cors_headers" name="Startback::Web::CorsHeaders when the app sets specific headers does not override them" file="./spec/unit/web/test_cors_headers.rb" time="0.000157"></testcase>
|
92
|
+
<testcase classname="spec.unit.web.test_healthcheck" name="Startback::Web::HealthCheck when used without a block and no failure returns a 204 when ok" file="./spec/unit/web/test_healthcheck.rb" time="0.000134"></testcase>
|
93
|
+
<testcase classname="spec.unit.web.test_healthcheck" name="Startback::Web::HealthCheck when used without a block a failure raises when ko" file="./spec/unit/web/test_healthcheck.rb" time="0.000143"></testcase>
|
94
|
+
<testcase classname="spec.unit.web.test_healthcheck" name="Startback::Web::HealthCheck when used with a block returning a debug message returns a 200 with plain text message" file="./spec/unit/web/test_healthcheck.rb" time="0.000146"></testcase>
|
95
|
+
<testcase classname="spec.unit.web.test_healthcheck" name="Startback::Web::HealthCheck when used with a block raising an exception re-raises it" file="./spec/unit/web/test_healthcheck.rb" time="0.000111"></testcase>
|
96
|
+
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when used as an app works as expected" file="./spec/unit/web/test_magic_assets.rb" time="0.514185"></testcase>
|
97
|
+
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when used as an app delegates a [] call to sprockets" file="./spec/unit/web/test_magic_assets.rb" time="0.254953"></testcase>
|
98
|
+
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when used as an app returns a 404 on unknown" file="./spec/unit/web/test_magic_assets.rb" time="0.000797"></testcase>
|
99
|
+
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when used as a middleware lets unrelated things pass" file="./spec/unit/web/test_magic_assets.rb" time="0.000317"></testcase>
|
100
|
+
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when used as a middleware serves the assets under the chosen path" file="./spec/unit/web/test_magic_assets.rb" time="0.255270"></testcase>
|
101
|
+
<testcase classname="spec.unit.web.test_magic_assets" name="Startback::Web::MagicAssets when registering the NgHtmlTransformer works as expected" file="./spec/unit/web/test_magic_assets.rb" time="0.260560"></testcase>
|
100
102
|
</testsuite>
|
@@ -0,0 +1,72 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
require 'startback/audit'
|
3
|
+
module Startback
|
4
|
+
module Audit
|
5
|
+
describe Prometheus do
|
6
|
+
|
7
|
+
EXPORTER = Prometheus.new({
|
8
|
+
prefix: "hello",
|
9
|
+
labels: {
|
10
|
+
app_version: "1.0"
|
11
|
+
}
|
12
|
+
})
|
13
|
+
|
14
|
+
class Runner
|
15
|
+
include Startback::Support::OperationRunner
|
16
|
+
|
17
|
+
class IdealOp < Startback::Operation
|
18
|
+
def call
|
19
|
+
42
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
class ExceptionalOp < Startback::Operation
|
24
|
+
def call
|
25
|
+
raise "Oops"
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
around_run(EXPORTER)
|
30
|
+
def test
|
31
|
+
run IdealOp.new
|
32
|
+
end
|
33
|
+
def test_exp
|
34
|
+
run ExceptionalOp.new
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
describe 'The ideal case' do
|
39
|
+
before do
|
40
|
+
expect(EXPORTER.calls).to receive(:observe).with(
|
41
|
+
kind_of(Numeric),
|
42
|
+
hash_including(labels: {
|
43
|
+
operation: "Startback::Audit::Runner::IdealOp",
|
44
|
+
startback_version: Startback::VERSION,
|
45
|
+
app_version: "1.0"
|
46
|
+
}))
|
47
|
+
expect(EXPORTER.errors).not_to receive(:increment)
|
48
|
+
end
|
49
|
+
it 'runs the operation' do
|
50
|
+
expect(Runner.new.test).to eql(42)
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
describe 'The exceptional case' do
|
55
|
+
before do
|
56
|
+
expect(EXPORTER.errors).to receive(:increment).with(
|
57
|
+
hash_including(labels: {
|
58
|
+
operation: "Startback::Audit::Runner::ExceptionalOp",
|
59
|
+
startback_version: Startback::VERSION,
|
60
|
+
app_version: "1.0"
|
61
|
+
})
|
62
|
+
)
|
63
|
+
expect(EXPORTER.calls).not_to receive(:observe)
|
64
|
+
end
|
65
|
+
it 'let errors bubble up' do
|
66
|
+
expect { Runner.new.test_exp }.to raise_error(/Oops/)
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
data/tasks/test.rake
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: startback
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.7.
|
4
|
+
version: 0.7.6
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Bernard Lambeau
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-12-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rspec
|
@@ -284,7 +284,7 @@ dependencies:
|
|
284
284
|
requirements:
|
285
285
|
- - ">="
|
286
286
|
- !ruby/object:Gem::Version
|
287
|
-
version: 0.17.
|
287
|
+
version: 0.17.5
|
288
288
|
- - "<"
|
289
289
|
- !ruby/object:Gem::Version
|
290
290
|
version: 0.18.0
|
@@ -294,7 +294,7 @@ dependencies:
|
|
294
294
|
requirements:
|
295
295
|
- - ">="
|
296
296
|
- !ruby/object:Gem::Version
|
297
|
-
version: 0.17.
|
297
|
+
version: 0.17.5
|
298
298
|
- - "<"
|
299
299
|
- !ruby/object:Gem::Version
|
300
300
|
version: 0.18.0
|
@@ -372,6 +372,20 @@ dependencies:
|
|
372
372
|
- - "<"
|
373
373
|
- !ruby/object:Gem::Version
|
374
374
|
version: '2.0'
|
375
|
+
- !ruby/object:Gem::Dependency
|
376
|
+
name: prometheus-client
|
377
|
+
requirement: !ruby/object:Gem::Requirement
|
378
|
+
requirements:
|
379
|
+
- - ">="
|
380
|
+
- !ruby/object:Gem::Version
|
381
|
+
version: '2.1'
|
382
|
+
type: :runtime
|
383
|
+
prerelease: false
|
384
|
+
version_requirements: !ruby/object:Gem::Requirement
|
385
|
+
requirements:
|
386
|
+
- - ">="
|
387
|
+
- !ruby/object:Gem::Version
|
388
|
+
version: '2.1'
|
375
389
|
description: Yet another ruby backend framework, I'm afraid
|
376
390
|
email: blambeau@gmail.com
|
377
391
|
executables: []
|
@@ -382,6 +396,7 @@ files:
|
|
382
396
|
- Rakefile
|
383
397
|
- lib/startback.rb
|
384
398
|
- lib/startback/audit.rb
|
399
|
+
- lib/startback/audit/prometheus.rb
|
385
400
|
- lib/startback/audit/trailer.rb
|
386
401
|
- lib/startback/bus.rb
|
387
402
|
- lib/startback/bus/bunny.rb
|
@@ -419,9 +434,11 @@ files:
|
|
419
434
|
- lib/startback/web/magic_assets/ng_html_transformer.rb
|
420
435
|
- lib/startback/web/magic_assets/rake_tasks.rb
|
421
436
|
- lib/startback/web/middleware.rb
|
437
|
+
- lib/startback/web/prometheus.rb
|
422
438
|
- lib/startback/web/shield.rb
|
423
439
|
- spec/rspec-unit.xml
|
424
440
|
- spec/spec_helper.rb
|
441
|
+
- spec/unit/audit/test_prometheus.rb
|
425
442
|
- spec/unit/audit/test_trailer.rb
|
426
443
|
- spec/unit/bus/memory/test_async.rb
|
427
444
|
- spec/unit/bus/memory/test_sync.rb
|
@@ -451,7 +468,7 @@ homepage: http://www.enspirit.be
|
|
451
468
|
licenses:
|
452
469
|
- MIT
|
453
470
|
metadata: {}
|
454
|
-
post_install_message:
|
471
|
+
post_install_message:
|
455
472
|
rdoc_options: []
|
456
473
|
require_paths:
|
457
474
|
- lib
|
@@ -466,8 +483,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
466
483
|
- !ruby/object:Gem::Version
|
467
484
|
version: '0'
|
468
485
|
requirements: []
|
469
|
-
rubygems_version: 3.1.
|
470
|
-
signing_key:
|
486
|
+
rubygems_version: 3.1.4
|
487
|
+
signing_key:
|
471
488
|
specification_version: 4
|
472
489
|
summary: Got Your Ruby Back
|
473
490
|
test_files: []
|