karafka-testing 1.4.1 → 2.0.0.alpha1

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 19130847e9607348b55eedc0d6a646113548875734d63ea9ba6b652708ab1b9e
4
- data.tar.gz: b63887118ed136596a44484f34cb781f466de860e27618f5d13ee09c45686b26
3
+ metadata.gz: 99b31b45b503aded03f25274fc7819219b3707644cbfa57a6136426351b52ae1
4
+ data.tar.gz: 1321c4e974d9dcd25f9f38fb0b8237a503d3f4399cc08ea299820d6dd8ce2479
5
5
  SHA512:
6
- metadata.gz: a3d3ab80d3987864875eb2c6e1bfae0865616c0f40400a6f6668b35710ca8dfc4ded231dfbb1d1e827ce4932376bb81cda5d03f3bc9a39a6db40b5b5864c3aa6
7
- data.tar.gz: e8576e71a4e3a0cd5394e1c06990a917b67a41ab311d945c4cc5420588abc063bfbae9d6eee4e95de9dc8b770986192952f2110135cf6a6794ff67259c017301
6
+ metadata.gz: aeb543efd92f2c9c7cafb50bb389e8d0baf388ce086cbe8751b2a2362d1e666c96766f771ff3fe20d38fcc9d3f8b69563073d4709fc93d756c880cbf4c6646e1
7
+ data.tar.gz: c5eb1aaeeedeb7ab8c08e77998422b5a249069818b50abc842e9cf0d9599b59f07d88167e71c4d9791f62e979babb15b659816fb9249a8927e11e65909d40e1f
checksums.yaml.gz.sig CHANGED
Binary file
@@ -1,6 +1,9 @@
1
1
  name: ci
2
2
 
3
+ concurrency: ci-${{ github.ref }}
4
+
3
5
  on:
6
+ pull_request:
4
7
  push:
5
8
  schedule:
6
9
  - cron: '0 1 * * *'
@@ -8,15 +11,16 @@ on:
8
11
  jobs:
9
12
  specs:
10
13
  runs-on: ubuntu-latest
14
+ needs: diffend
11
15
  strategy:
12
16
  fail-fast: false
13
17
  matrix:
14
18
  ruby:
19
+ - '3.1'
20
+ - '3.0'
15
21
  - '2.7'
16
- - '2.6'
17
- - '2.5'
18
22
  include:
19
- - ruby: '2.7'
23
+ - ruby: '3.1'
20
24
  coverage: 'true'
21
25
  steps:
22
26
  - uses: actions/checkout@v2
@@ -32,6 +36,26 @@ jobs:
32
36
  - name: Bundle install
33
37
  run: |
34
38
  bundle install --jobs 4 --retry 3
39
+
40
+ diffend:
41
+ runs-on: ubuntu-latest
42
+ strategy:
43
+ fail-fast: false
44
+ steps:
45
+ - uses: actions/checkout@v2
46
+ with:
47
+ fetch-depth: 0
48
+ - name: Set up Ruby
49
+ uses: ruby/setup-ruby@v1
50
+ with:
51
+ ruby-version: 3.1
52
+ - name: Install latest bundler
53
+ run: gem install bundler --no-document
54
+ - name: Install Diffend plugin
55
+ run: bundle plugin install diffend
56
+ - name: Bundle Secure
57
+ run: bundle secure
58
+
35
59
  coditsu:
36
60
  runs-on: ubuntu-latest
37
61
  strategy:
data/.ruby-version CHANGED
@@ -1 +1 @@
1
- 2.7.1
1
+ 3.1.0
data/2.0-Upgrade.md ADDED
@@ -0,0 +1,60 @@
1
+ # Welcome to Karafka-Testing 2.0!
2
+
3
+ Karafka-Testing 2.0 some breaking changes in the way consumer builder and message publishing is done.
4
+
5
+ ## Upgrade
6
+
7
+ Please upgrade your application to `Karafka 2.0` first.
8
+
9
+ - Replace `#karafka_consumer_for` in your specs with `#karafka.consumer_for`
10
+ - Replace `#publish_for_karafka` in your specs with `#karafka.publish`
11
+
12
+ And that's all!
13
+
14
+ Below you can find same example written for Karafka `2.0` and `1.4`.
15
+
16
+ ### Karafka 2.0
17
+
18
+ ```ruby
19
+ RSpec.describe CountersConsumer do
20
+ subject(:consumer) { karafka.consumer_for(:counters) }
21
+
22
+ let(:nr1_value) { rand }
23
+ let(:nr2_value) { rand }
24
+ let(:sum) { nr1_value + nr2_value }
25
+
26
+ before do
27
+ karafka.publish({ 'number' => nr1_value }.to_json)
28
+ karafka.publish({ 'number' => nr2_value }.to_json, partition: 2)
29
+ allow(Karafka.logger).to receive(:info)
30
+ end
31
+
32
+ it 'expects to log a proper message' do
33
+ expect(Karafka.logger).to receive(:info).with("Sum of 2 elements equals to: #{sum}")
34
+ consumer.consume
35
+ end
36
+ end
37
+ ```
38
+
39
+ ### Karafka 1.4
40
+
41
+ ```ruby
42
+ RSpec.describe InlineBatchConsumer do
43
+ subject(:consumer) { karafka_consumer_for(:counters) }
44
+
45
+ let(:nr1_value) { rand }
46
+ let(:nr2_value) { rand }
47
+ let(:sum) { nr1_value + nr2_value }
48
+
49
+ before do
50
+ publish_for_karafka({ 'number' => nr1_value }.to_json)
51
+ publish_for_karafka({ 'number' => nr2_value }.to_json, partition: 2)
52
+ allow(Karafka.logger).to receive(:info)
53
+ end
54
+
55
+ it 'expects to log a proper message' do
56
+ expect(Karafka.logger).to receive(:info).with("Sum of 2 elements equals to: #{sum}")
57
+ consumer.consume
58
+ end
59
+ end
60
+ ```
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Karafka Test gem changelog
2
2
 
3
+ ## 2.0.0.alpha1 (2022-01-30)
4
+ - Change the API to be more comprehensive
5
+ - Update to work with Karafka 2.0
6
+ - Support for Ruby 3.1
7
+
8
+ ## 1.4.2 (2021-04-21)
9
+ - Restore MIT license
10
+ - Remove Ruby 2.5 support and update minimum Ruby requirement to 2.6
11
+
3
12
  ## 1.4.1 (2020-09-05)
4
13
  - Fix for Ruby 2.5 and 2.6 support
5
14
 
data/Gemfile.lock CHANGED
@@ -1,103 +1,82 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- karafka-testing (1.4.1)
5
- karafka (~> 1.4.0.rc2)
4
+ karafka-testing (2.0.0.alpha1)
5
+ karafka (~> 2.0.alpha1)
6
6
 
7
7
  GEM
8
8
  remote: https://rubygems.org/
9
9
  specs:
10
- concurrent-ruby (1.1.7)
11
- delivery_boy (1.0.1)
12
- king_konf (~> 0.3)
13
- ruby-kafka (~> 1.0)
14
- digest-crc (0.6.1)
15
- rake (~> 13.0)
16
- dry-configurable (0.11.6)
10
+ concurrent-ruby (1.1.9)
11
+ dry-configurable (0.14.0)
17
12
  concurrent-ruby (~> 1.0)
18
- dry-core (~> 0.4, >= 0.4.7)
19
- dry-equalizer (~> 0.2)
20
- dry-container (0.7.2)
13
+ dry-core (~> 0.6)
14
+ dry-container (0.9.0)
21
15
  concurrent-ruby (~> 1.0)
22
- dry-configurable (~> 0.1, >= 0.1.3)
23
- dry-core (0.4.9)
16
+ dry-configurable (~> 0.13, >= 0.13.0)
17
+ dry-core (0.7.1)
24
18
  concurrent-ruby (~> 1.0)
25
- dry-equalizer (0.3.0)
26
- dry-events (0.2.0)
19
+ dry-events (0.3.0)
27
20
  concurrent-ruby (~> 1.0)
28
- dry-core (~> 0.4)
29
- dry-equalizer (~> 0.2)
30
- dry-inflector (0.2.0)
31
- dry-initializer (3.0.3)
32
- dry-logic (1.0.7)
21
+ dry-core (~> 0.5, >= 0.5)
22
+ dry-inflector (0.2.1)
23
+ dry-initializer (3.1.1)
24
+ dry-logic (1.2.0)
33
25
  concurrent-ruby (~> 1.0)
34
- dry-core (~> 0.2)
35
- dry-equalizer (~> 0.2)
36
- dry-monitor (0.3.2)
37
- dry-configurable (~> 0.5)
38
- dry-core (~> 0.4)
39
- dry-equalizer (~> 0.2)
26
+ dry-core (~> 0.5, >= 0.5)
27
+ dry-monitor (0.5.0)
28
+ dry-configurable (~> 0.13, >= 0.13.0)
29
+ dry-core (~> 0.5, >= 0.5)
40
30
  dry-events (~> 0.2)
41
- dry-schema (1.5.4)
31
+ dry-schema (1.8.0)
42
32
  concurrent-ruby (~> 1.0)
43
- dry-configurable (~> 0.8, >= 0.8.3)
44
- dry-core (~> 0.4)
45
- dry-equalizer (~> 0.2)
33
+ dry-configurable (~> 0.13, >= 0.13.0)
34
+ dry-core (~> 0.5, >= 0.5)
46
35
  dry-initializer (~> 3.0)
47
36
  dry-logic (~> 1.0)
48
- dry-types (~> 1.4)
49
- dry-types (1.4.0)
37
+ dry-types (~> 1.5)
38
+ dry-types (1.5.1)
50
39
  concurrent-ruby (~> 1.0)
51
40
  dry-container (~> 0.3)
52
- dry-core (~> 0.4, >= 0.4.4)
53
- dry-equalizer (~> 0.3)
41
+ dry-core (~> 0.5, >= 0.5)
54
42
  dry-inflector (~> 0.1, >= 0.1.2)
55
43
  dry-logic (~> 1.0, >= 1.0.2)
56
- dry-validation (1.5.6)
44
+ dry-validation (1.7.0)
57
45
  concurrent-ruby (~> 1.0)
58
46
  dry-container (~> 0.7, >= 0.7.1)
59
- dry-core (~> 0.4)
60
- dry-equalizer (~> 0.2)
47
+ dry-core (~> 0.5, >= 0.5)
61
48
  dry-initializer (~> 3.0)
62
- dry-schema (~> 1.5, >= 1.5.2)
63
- envlogic (1.1.2)
64
- dry-inflector (~> 0.1)
65
- io-console (0.5.6)
66
- irb (1.2.4)
67
- reline (>= 0.0.1)
68
- karafka (1.4.0.rc2)
69
- dry-configurable (~> 0.8)
70
- dry-inflector (~> 0.1)
71
- dry-monitor (~> 0.3)
72
- dry-validation (~> 1.2)
73
- envlogic (~> 1.1)
74
- irb (~> 1.0)
75
- rake (>= 11.3)
76
- ruby-kafka (>= 1.0.0)
49
+ dry-schema (~> 1.8, >= 1.8.0)
50
+ ffi (1.15.5)
51
+ karafka (2.0.0.alpha1)
52
+ dry-configurable (~> 0.13)
53
+ dry-monitor (~> 0.5)
54
+ dry-validation (~> 1.7)
55
+ rdkafka (>= 0.10)
77
56
  thor (>= 0.20)
78
- waterdrop (~> 1.4.0)
79
- zeitwerk (~> 2.1)
80
- king_konf (0.3.7)
81
- rake (13.0.1)
82
- reline (0.1.4)
83
- io-console (~> 0.5)
84
- ruby-kafka (1.2.0)
85
- digest-crc
86
- thor (1.0.1)
87
- waterdrop (1.4.0)
88
- delivery_boy (>= 0.2, < 2.x)
89
- dry-configurable (~> 0.8)
90
- dry-monitor (~> 0.3)
91
- dry-validation (~> 1.2)
92
- ruby-kafka (>= 0.7.8)
93
- zeitwerk (~> 2.1)
94
- zeitwerk (2.4.0)
57
+ waterdrop (>= 2.1.0, < 3.0.0)
58
+ zeitwerk (~> 2.3)
59
+ mini_portile2 (2.7.1)
60
+ rake (13.0.6)
61
+ rdkafka (0.11.1)
62
+ ffi (~> 1.15)
63
+ mini_portile2 (~> 2.6)
64
+ rake (> 12)
65
+ thor (1.2.1)
66
+ waterdrop (2.1.0)
67
+ concurrent-ruby (>= 1.1)
68
+ dry-configurable (~> 0.13)
69
+ dry-monitor (~> 0.5)
70
+ dry-validation (~> 1.7)
71
+ rdkafka (>= 0.10)
72
+ zeitwerk (~> 2.3)
73
+ zeitwerk (2.5.4)
95
74
 
96
75
  PLATFORMS
97
- ruby
76
+ x86_64-linux
98
77
 
99
78
  DEPENDENCIES
100
79
  karafka-testing!
101
80
 
102
81
  BUNDLED WITH
103
- 2.1.4
82
+ 2.3.5
data/MIT-LICENSE ADDED
@@ -0,0 +1,18 @@
1
+ Permission is hereby granted, free of charge, to any person obtaining
2
+ a copy of this software and associated documentation files (the
3
+ "Software"), to deal in the Software without restriction, including
4
+ without limitation the rights to use, copy, modify, merge, publish,
5
+ distribute, sublicense, and/or sell copies of the Software, and to
6
+ permit persons to whom the Software is furnished to do so, subject to
7
+ the following conditions:
8
+
9
+ The above copyright notice and this permission notice shall be
10
+ included in all copies or substantial portions of the Software.
11
+
12
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
13
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
15
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
16
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
17
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
18
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md CHANGED
@@ -1,9 +1,14 @@
1
1
  # Karafka Testing library
2
2
 
3
+ **Note**: Documentation presented below works with not yet released Karafka `2.0`.
4
+
5
+ Please refer to [this](https://github.com/karafka/testing/tree/1.4) branch and its documentation for details about usage with Karafka `1.4`.
6
+
3
7
  [![Build Status](https://github.com/karafka/testing/workflows/ci/badge.svg)](https://github.com/karafka/testing/actions?query=workflow%3Aci)
4
- [![Join the chat at https://gitter.im/karafka/karafka](https://badges.gitter.im/karafka/karafka.svg)](https://gitter.im/karafka/karafka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
8
+ [![Gem Version](https://badge.fury.io/rb/karafka-testing.svg)](http://badge.fury.io/rb/karafka-testing)
9
+ [![Join the chat at https://slack.karafka.io](https://raw.githubusercontent.com/karafka/misc/master/slack.svg)](https://slack.karafka.io)
5
10
 
6
- Karafka-Testing is a library that provides rspec helpers, to make testing of Karafka consumers much easier.
11
+ Karafka-Testing is a library that provides RSpec helpers, to make testing of Karafka consumers much easier.
7
12
 
8
13
  ## Installation
9
14
 
@@ -27,18 +32,17 @@ end
27
32
 
28
33
  ## Usage
29
34
 
30
- Once included into your RSpec setup, this library will provide you two methods that you can use with your specs:
35
+ Once included into your RSpec setup, this library will provide you with a special object `#karafka` that includes two methods that you can use with your specs:
31
36
 
32
- - `#karafka_consumer_for` - this method will create a consumer instance for the desired topic. It **needs** to be set as the spec subject.
33
- - `#publish_for_karafka` - this method will "send" message to the consumer instance.
37
+ - `#consumer_for` - creates a consumer instance for the desired topic. It **needs** to be set as the spec subject.
38
+ - `#publish` - "sends" message to the consumer instance.
34
39
 
35
-
36
- **Note:** Messages sent using the `#publish_for_karafka` method won't be sent to Kafka. They will be "virtually" delegated to the created consumer instance so your specs can run without Kafka setup.
40
+ **Note:** Messages sent using the `#publish` method won't be sent to Kafka. They will be "virtually" delegated to the created consumer instance so your specs can run without Kafka setup.
37
41
 
38
42
  ```ruby
39
43
  RSpec.describe InlineBatchConsumer do
40
44
  # This will create a consumer instance with all the settings defined for the given topic
41
- subject(:consumer) { karafka_consumer_for(:inline_batch_data) }
45
+ subject(:consumer) { karafka.consumer_for(:inline_batch_data) }
42
46
 
43
47
  let(:nr1_value) { rand }
44
48
  let(:nr2_value) { rand }
@@ -46,9 +50,9 @@ RSpec.describe InlineBatchConsumer do
46
50
 
47
51
  before do
48
52
  # Sends first message to Karafka consumer
49
- publish_for_karafka({ 'number' => nr1_value }.to_json)
53
+ karafka.publish({ 'number' => nr1_value }.to_json)
50
54
  # Sends second message to Karafka consumer
51
- publish_for_karafka({ 'number' => nr2_value }.to_json)
55
+ karafka.publish({ 'number' => nr2_value }.to_json, partition: 2)
52
56
  allow(Karafka.logger).to receive(:info)
53
57
  end
54
58
 
@@ -59,20 +63,10 @@ RSpec.describe InlineBatchConsumer do
59
63
  end
60
64
  ```
61
65
 
62
- ## References
63
-
64
- * [Karafka framework](https://github.com/karafka/karafka)
65
- * [Karafka Testing Actions CI](https://github.com/karafka/testing/actions?query=workflow%3Aci)
66
- * [Karafka Testing Coditsu](https://app.coditsu.io/karafka/repositories/testing)
67
-
68
66
  ## Note on contributions
69
67
 
70
- First, thank you for considering contributing to Karafka Testing! It's people like you that make the open source community such a great community!
71
-
72
- Each pull request must pass all the RSpec specs and meet our quality requirements.
73
-
74
- To check if everything is as it should be, we use [Coditsu](https://coditsu.io) that combines multiple linters and code analyzers for both code and documentation. Once you're done with your changes, submit a pull request.
68
+ First, thank you for considering contributing to the Karafka ecosystem! It's people like you that make the open source community such a great community!
75
69
 
76
- Coditsu will automatically check your work against our quality standards. You can find your commit check results on the [builds page](https://app.coditsu.io/karafka/repositories/test/builds/commit_builds) of the Karafka Testing repository.
70
+ Each pull request must pass all the RSpec specs, integration tests and meet our quality requirements.
77
71
 
78
- [![coditsu](https://coditsu.io/assets/quality_bar.svg)](https://app.coditsu.io/karafka/repositories/testing/builds/commit_builds)
72
+ Fork it, update and wait for the Github Actions results.
data/certs/mensfeld.pem CHANGED
@@ -1,25 +1,25 @@
1
1
  -----BEGIN CERTIFICATE-----
2
2
  MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhtYWNp
3
- ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMjAwODExMDkxNTM3WhcNMjEwODExMDkx
4
- NTM3WjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
5
- CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDCpXsCgmINb6lHBXXBdyrgsBPSxC4/
6
- 2H+weJ6L9CruTiv2+2/ZkQGtnLcDgrD14rdLIHK7t0o3EKYlDT5GhD/XUVhI15JE
7
- N7IqnPUgexe1fbZArwQ51afxz2AmPQN2BkB2oeQHXxnSWUGMhvcEZpfbxCCJH26w
8
- hS0Ccsma8yxA6hSlGVhFVDuCr7c2L1di6cK2CtIDpfDaWqnVNJEwBYHIxrCoWK5g
9
- sIGekVt/admS9gRhIMaIBg+Mshth5/DEyWO2QjteTodItlxfTctrfmiAl8X8T5JP
10
- VXeLp5SSOJ5JXE80nShMJp3RFnGw5fqjX/ffjtISYh78/By4xF3a25HdWH9+qO2Z
11
- tx0wSGc9/4gqNM0APQnjN/4YXrGZ4IeSjtE+OrrX07l0TiyikzSLFOkZCAp8oBJi
12
- Fhlosz8xQDJf7mhNxOaZziqASzp/hJTU/tuDKl5+ql2icnMv5iV/i6SlmvU29QNg
13
- LCV71pUv0pWzN+OZbHZKWepGhEQ3cG9MwvkCAwEAAaN3MHUwCQYDVR0TBAIwADAL
14
- BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFImGed2AXS070ohfRidiCEhXEUN+MB0GA1Ud
3
+ ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMjEwODExMTQxNTEzWhcNMjIwODExMTQx
4
+ NTEzWjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
5
+ CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDV2jKH4Ti87GM6nyT6D+ESzTI0MZDj
6
+ ak2/TEwnxvijMJyCCPKT/qIkbW4/f0VHM4rhPr1nW73sb5SZBVFCLlJcOSKOBdUY
7
+ TMY+SIXN2EtUaZuhAOe8LxtxjHTgRHvHcqUQMBENXTISNzCo32LnUxweu66ia4Pd
8
+ 1mNRhzOqNv9YiBZvtBf7IMQ+sYdOCjboq2dlsWmJiwiDpY9lQBTnWORnT3mQxU5x
9
+ vPSwnLB854cHdCS8fQo4DjeJBRZHhEbcE5sqhEMB3RZA3EtFVEXOxlNxVTS3tncI
10
+ qyNXiWDaxcipaens4ObSY1C2HTV7OWb7OMqSCIybeYTSfkaSdqmcl4S6zxXkjH1J
11
+ tnjayAVzD+QVXGijsPLE2PFnJAh9iDET2cMsjabO1f6l1OQNyAtqpcyQcgfnyW0z
12
+ g7tGxTYD+6wJHffM9d9txOUw6djkF6bDxyqB8lo4Z3IObCx18AZjI9XPS9QG7w6q
13
+ LCWuMG2lkCcRgASqaVk9fEf9yMc2xxz5o3kCAwEAAaN3MHUwCQYDVR0TBAIwADAL
14
+ BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFBqUFCKCOe5IuueUVqOB991jyCLLMB0GA1Ud
15
15
  EQQWMBSBEm1hY2llakBtZW5zZmVsZC5wbDAdBgNVHRIEFjAUgRJtYWNpZWpAbWVu
16
- c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBAKiHpwoENVrMi94V1zD4o8/6G3AU
17
- gWz4udkPYHTZLUy3dLznc/sNjdkJFWT3E6NKYq7c60EpJ0m0vAEg5+F5pmNOsvD3
18
- 2pXLj9kisEeYhR516HwXAvtngboUcb75skqvBCU++4Pu7BRAPjO1/ihLSBexbwSS
19
- fF+J5OWNuyHHCQp+kGPLtXJe2yUYyvSWDj3I2//Vk0VhNOIlaCS1+5/P3ZJThOtm
20
- zJUBI7h3HgovwRpcnmk2mXTmU4Zx/bCzX8EA6VY0khEvnmiq7S6eBF0H9qH8KyQ6
21
- EkVLpvmUDFcf/uNaBQdazEMB5jYtwoA8gQlANETNGPi51KlkukhKgaIEDMkBDJOx
22
- 65N7DzmkcyY0/GwjIVIxmRhcrCt1YeCUElmfFx0iida1/YRm6sB2AXqScc1+ECRi
23
- 2DND//YJUikn1zwbz1kT70XmHd97B4Eytpln7K+M1u2g1pHVEPW4owD/ammXNpUy
24
- nt70FcDD4yxJQ+0YNiHd0N8IcVBM1TMIVctMNQ==
16
+ c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBADD0/UuTTFgW+CGk2U0RDw2RBOca
17
+ W2LTF/G7AOzuzD0Tc4voc7WXyrgKwJREv8rgBimLnNlgmFJLmtUCh2U/MgxvcilH
18
+ yshYcbseNvjkrtYnLRlWZR4SSB6Zei5AlyGVQLPkvdsBpNegcG6w075YEwzX/38a
19
+ 8V9B/Yri2OGELBz8ykl7BsXUgNoUPA/4pHF6YRLz+VirOaUIQ4JfY7xGj6fSOWWz
20
+ /rQ/d77r6o1mfJYM/3BRVg73a3b7DmRnE5qjwmSaSQ7u802pJnLesmArch0xGCT/
21
+ fMmRli1Qb+6qOTl9mzD6UDMAyFR4t6MStLm0mIEqM0nBO5nUdUWbC7l9qXEf8XBE
22
+ 2DP28p3EqSuS+lKbAWKcqv7t0iRhhmaod+Yn9mcrLN1sa3q3KSQ9BCyxezCD4Mk2
23
+ R2P11bWoCtr70BsccVrN8jEhzwXngMyI2gVt750Y+dbTu1KgRqZKp/ECe7ZzPzXj
24
+ pIy9vHxTANKYVyI4qj8OrFdEM5BQNu8oQpL0iQ==
25
25
  -----END CERTIFICATE-----
@@ -13,18 +13,19 @@ Gem::Specification.new do |spec|
13
13
  spec.email = %w[maciej@mensfeld.pl]
14
14
  spec.summary = 'Library which provides helpers for easier Karafka consumers tests'
15
15
  spec.description = 'Library which provides helpers for easier Karafka consumers tests'
16
- spec.homepage = 'https://github.com/karafka/testing'
17
- spec.license = 'LGPL-3.0'
16
+ spec.homepage = 'https://karafka.io'
17
+ spec.license = 'MIT'
18
18
  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
19
19
  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
20
20
  spec.require_paths = %w[lib]
21
21
  spec.cert_chain = %w[certs/mensfeld.pem]
22
+ spec.metadata = { 'source_code_uri' => 'https://github.com/karafka/testing' }
22
23
 
23
- spec.required_ruby_version = '>= 2.5.0'
24
+ spec.required_ruby_version = '>= 2.6.0'
24
25
 
25
26
  if $PROGRAM_NAME.end_with?('gem')
26
27
  spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
27
28
  end
28
29
 
29
- spec.add_dependency 'karafka', '~> 1.4.0.rc2'
30
+ spec.add_dependency 'karafka', '~> 2.0.alpha1'
30
31
  end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Karafka
4
+ module Testing
5
+ # A dummy client that takes over client delegated methods from the consumers
6
+ # For specs we do not mark anything as consumed, nor do we really send heartbeats.
7
+ # Those things are tested in the framework itself
8
+ class DummyClient
9
+ %i[
10
+ mark_as_consumed
11
+ mark_as_consumed!
12
+ ].each do |caught_delegator|
13
+ define_method(caught_delegator) { |*| }
14
+ end
15
+ end
16
+ end
17
+ end
@@ -1,6 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require 'karafka/testing/errors'
4
+ require 'karafka/testing/dummy_client'
5
+ require 'karafka/testing/rspec/proxy'
4
6
 
5
7
  module Karafka
6
8
  module Testing
@@ -15,14 +17,15 @@ module Karafka
15
17
  def included(base)
16
18
  # This is an internal buffer for keeping "to be sent" messages before
17
19
  # we run the consume
18
- base.let(:_karafka_raw_data) { [] }
19
- # Clear the messages buffer after each spec, so nothing will leak
20
- # in between them
21
- base.after { _karafka_raw_data.clear }
20
+ base.let(:_karafka_messages) { [] }
21
+ base.let(:karafka) { Karafka::Testing::RSpec::Proxy.new(self) }
22
+ # Clear the messages buffer after each spec, so nothing leaks in between them
23
+ base.after { _karafka_messages.clear }
22
24
  end
23
25
  end
24
26
 
25
- # Creates a consumer instance for given topic
27
+ # Creates a consumer instance for a given topic
28
+ #
26
29
  # @param requested_topic [String, Symbol] name of the topic for which we want to
27
30
  # create a consumer instance
28
31
  # @return [Object] described_class instance
@@ -31,12 +34,12 @@ module Karafka
31
34
  #
32
35
  # @example Creates a MyConsumer consumer instance with settings for `my_requested_topic`
33
36
  # RSpec.describe MyConsumer do
34
- # subject(:consumer) { karafka_consumer_for(:my_requested_topic) }
37
+ # subject(:consumer) { karafka.consumer_for(:my_requested_topic) }
35
38
  # end
36
39
  def karafka_consumer_for(requested_topic)
37
40
  selected_topic = nil
38
41
 
39
- # @note Remove in 2.0. This won't work without the global state
42
+ # @note Remove in 2.1. This won't work without the global state
40
43
  ::Karafka::App.consumer_groups.each do |consumer_group|
41
44
  consumer_group.topics.each do |topic|
42
45
  selected_topic = topic if topic.name == requested_topic.to_s
@@ -45,47 +48,59 @@ module Karafka
45
48
 
46
49
  raise Karafka::Testing::Errors::TopicNotFoundError, requested_topic unless selected_topic
47
50
 
48
- described_class.new(selected_topic)
51
+ consumer = described_class.new
52
+ consumer.topic = selected_topic
53
+ consumer.client = Karafka::Testing::DummyClient.new
54
+ consumer
49
55
  end
50
56
 
51
- # Adds a new Karafka params instance with given payload and options into an internal
57
+ # Adds a new Karafka message instance with given payload and options into an internal
52
58
  # buffer that will be used to simulate messages delivery to the consumer
53
59
  #
54
- # @param raw_payload [String] anything you want to send
60
+ # @param payload [String] anything you want to send
55
61
  # @param opts [Hash] additional options with which you want to overwrite the
56
62
  # message defaults (key, offset, etc)
57
63
  #
58
64
  # @example Send a json message to consumer
59
65
  # before do
60
- # publish_for_karafka({ 'hello' => 'world' }.to_json)
66
+ # karafka.publish({ 'hello' => 'world' }.to_json)
61
67
  # end
62
68
  #
63
69
  # @example Send a json message to consumer and simulate, that it is partition 6
64
70
  # before do
65
- # publish_for_karafka({ 'hello' => 'world' }.to_json, 'partition' => 6)
71
+ # karafka.publish({ 'hello' => 'world' }.to_json, 'partition' => 6)
66
72
  # end
67
- def publish_for_karafka(raw_payload, opts = {})
68
- metadata = Karafka::Params::Metadata.new(
69
- **metadata_defaults.merge(opts)
73
+ def karafka_publish(payload, opts = {})
74
+ metadata = Karafka::Messages::Metadata.new(
75
+ **karafka_message_metadata_defaults.merge(opts)
70
76
  ).freeze
71
77
 
72
- _karafka_raw_data << Karafka::Params::Params.new(raw_payload, metadata)
73
- subject.params_batch = Karafka::Params::ParamsBatch.new(_karafka_raw_data)
78
+ # Add this message to previously published messages
79
+ _karafka_messages << Karafka::Messages::Message.new(payload, metadata)
80
+
81
+ # Update batch metadata
82
+ batch_metadata = Karafka::Messages::Builders::BatchMetadata.call(
83
+ _karafka_messages,
84
+ subject.topic,
85
+ Time.now
86
+ )
87
+
88
+ # Update consumer messages batch
89
+ subject.messages = Karafka::Messages::Messages.new(_karafka_messages, batch_metadata)
74
90
  end
75
91
 
76
92
  private
77
93
 
78
94
  # @return [Hash] message default options
79
- def metadata_defaults
95
+ def karafka_message_metadata_defaults
80
96
  {
81
97
  deserializer: subject.topic.deserializer,
82
- create_time: Time.now,
98
+ timestamp: Time.now,
83
99
  headers: {},
84
- is_control_record: false,
85
100
  key: nil,
86
- offset: 0,
101
+ offset: _karafka_messages.size,
87
102
  partition: 0,
88
- receive_time: Time.now,
103
+ received_at: Time.now,
89
104
  topic: subject.topic.name
90
105
  }
91
106
  end
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Karafka
4
+ module Testing
5
+ module RSpec
6
+ # Proxy object for a nicer `karafka.` API within RSpec
7
+ class Proxy
8
+ # @param rspec_example [RSpec::ExampleGroups] rspec context
9
+ def initialize(rspec_example)
10
+ @rspec_example = rspec_example
11
+ end
12
+
13
+ # @param args Anything that the `#karafka_consumer_for` accepts
14
+ def consumer_for(*args)
15
+ @rspec_example.karafka_consumer_for(*args)
16
+ end
17
+
18
+ # @param args Anything that the `#karafka_publish` accepts
19
+ def publish(*args)
20
+ @rspec_example.karafka_publish(*args)
21
+ end
22
+ end
23
+ end
24
+ end
25
+ end
@@ -4,6 +4,6 @@
4
4
  module Karafka
5
5
  module Testing
6
6
  # Current version of gem. It should match Karafka framework version
7
- VERSION = '1.4.1'
7
+ VERSION = '2.0.0.alpha1'
8
8
  end
9
9
  end
data.tar.gz.sig CHANGED
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: karafka-testing
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.1
4
+ version: 2.0.0.alpha1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Maciej Mensfeld
@@ -11,30 +11,30 @@ cert_chain:
11
11
  - |
12
12
  -----BEGIN CERTIFICATE-----
13
13
  MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhtYWNp
14
- ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMjAwODExMDkxNTM3WhcNMjEwODExMDkx
15
- NTM3WjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
16
- CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDCpXsCgmINb6lHBXXBdyrgsBPSxC4/
17
- 2H+weJ6L9CruTiv2+2/ZkQGtnLcDgrD14rdLIHK7t0o3EKYlDT5GhD/XUVhI15JE
18
- N7IqnPUgexe1fbZArwQ51afxz2AmPQN2BkB2oeQHXxnSWUGMhvcEZpfbxCCJH26w
19
- hS0Ccsma8yxA6hSlGVhFVDuCr7c2L1di6cK2CtIDpfDaWqnVNJEwBYHIxrCoWK5g
20
- sIGekVt/admS9gRhIMaIBg+Mshth5/DEyWO2QjteTodItlxfTctrfmiAl8X8T5JP
21
- VXeLp5SSOJ5JXE80nShMJp3RFnGw5fqjX/ffjtISYh78/By4xF3a25HdWH9+qO2Z
22
- tx0wSGc9/4gqNM0APQnjN/4YXrGZ4IeSjtE+OrrX07l0TiyikzSLFOkZCAp8oBJi
23
- Fhlosz8xQDJf7mhNxOaZziqASzp/hJTU/tuDKl5+ql2icnMv5iV/i6SlmvU29QNg
24
- LCV71pUv0pWzN+OZbHZKWepGhEQ3cG9MwvkCAwEAAaN3MHUwCQYDVR0TBAIwADAL
25
- BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFImGed2AXS070ohfRidiCEhXEUN+MB0GA1Ud
14
+ ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMjEwODExMTQxNTEzWhcNMjIwODExMTQx
15
+ NTEzWjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
16
+ CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDV2jKH4Ti87GM6nyT6D+ESzTI0MZDj
17
+ ak2/TEwnxvijMJyCCPKT/qIkbW4/f0VHM4rhPr1nW73sb5SZBVFCLlJcOSKOBdUY
18
+ TMY+SIXN2EtUaZuhAOe8LxtxjHTgRHvHcqUQMBENXTISNzCo32LnUxweu66ia4Pd
19
+ 1mNRhzOqNv9YiBZvtBf7IMQ+sYdOCjboq2dlsWmJiwiDpY9lQBTnWORnT3mQxU5x
20
+ vPSwnLB854cHdCS8fQo4DjeJBRZHhEbcE5sqhEMB3RZA3EtFVEXOxlNxVTS3tncI
21
+ qyNXiWDaxcipaens4ObSY1C2HTV7OWb7OMqSCIybeYTSfkaSdqmcl4S6zxXkjH1J
22
+ tnjayAVzD+QVXGijsPLE2PFnJAh9iDET2cMsjabO1f6l1OQNyAtqpcyQcgfnyW0z
23
+ g7tGxTYD+6wJHffM9d9txOUw6djkF6bDxyqB8lo4Z3IObCx18AZjI9XPS9QG7w6q
24
+ LCWuMG2lkCcRgASqaVk9fEf9yMc2xxz5o3kCAwEAAaN3MHUwCQYDVR0TBAIwADAL
25
+ BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFBqUFCKCOe5IuueUVqOB991jyCLLMB0GA1Ud
26
26
  EQQWMBSBEm1hY2llakBtZW5zZmVsZC5wbDAdBgNVHRIEFjAUgRJtYWNpZWpAbWVu
27
- c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBAKiHpwoENVrMi94V1zD4o8/6G3AU
28
- gWz4udkPYHTZLUy3dLznc/sNjdkJFWT3E6NKYq7c60EpJ0m0vAEg5+F5pmNOsvD3
29
- 2pXLj9kisEeYhR516HwXAvtngboUcb75skqvBCU++4Pu7BRAPjO1/ihLSBexbwSS
30
- fF+J5OWNuyHHCQp+kGPLtXJe2yUYyvSWDj3I2//Vk0VhNOIlaCS1+5/P3ZJThOtm
31
- zJUBI7h3HgovwRpcnmk2mXTmU4Zx/bCzX8EA6VY0khEvnmiq7S6eBF0H9qH8KyQ6
32
- EkVLpvmUDFcf/uNaBQdazEMB5jYtwoA8gQlANETNGPi51KlkukhKgaIEDMkBDJOx
33
- 65N7DzmkcyY0/GwjIVIxmRhcrCt1YeCUElmfFx0iida1/YRm6sB2AXqScc1+ECRi
34
- 2DND//YJUikn1zwbz1kT70XmHd97B4Eytpln7K+M1u2g1pHVEPW4owD/ammXNpUy
35
- nt70FcDD4yxJQ+0YNiHd0N8IcVBM1TMIVctMNQ==
27
+ c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBADD0/UuTTFgW+CGk2U0RDw2RBOca
28
+ W2LTF/G7AOzuzD0Tc4voc7WXyrgKwJREv8rgBimLnNlgmFJLmtUCh2U/MgxvcilH
29
+ yshYcbseNvjkrtYnLRlWZR4SSB6Zei5AlyGVQLPkvdsBpNegcG6w075YEwzX/38a
30
+ 8V9B/Yri2OGELBz8ykl7BsXUgNoUPA/4pHF6YRLz+VirOaUIQ4JfY7xGj6fSOWWz
31
+ /rQ/d77r6o1mfJYM/3BRVg73a3b7DmRnE5qjwmSaSQ7u802pJnLesmArch0xGCT/
32
+ fMmRli1Qb+6qOTl9mzD6UDMAyFR4t6MStLm0mIEqM0nBO5nUdUWbC7l9qXEf8XBE
33
+ 2DP28p3EqSuS+lKbAWKcqv7t0iRhhmaod+Yn9mcrLN1sa3q3KSQ9BCyxezCD4Mk2
34
+ R2P11bWoCtr70BsccVrN8jEhzwXngMyI2gVt750Y+dbTu1KgRqZKp/ECe7ZzPzXj
35
+ pIy9vHxTANKYVyI4qj8OrFdEM5BQNu8oQpL0iQ==
36
36
  -----END CERTIFICATE-----
37
- date: 2020-09-05 00:00:00.000000000 Z
37
+ date: 2022-01-30 00:00:00.000000000 Z
38
38
  dependencies:
39
39
  - !ruby/object:Gem::Dependency
40
40
  name: karafka
@@ -42,14 +42,14 @@ dependencies:
42
42
  requirements:
43
43
  - - "~>"
44
44
  - !ruby/object:Gem::Version
45
- version: 1.4.0.rc2
45
+ version: 2.0.alpha1
46
46
  type: :runtime
47
47
  prerelease: false
48
48
  version_requirements: !ruby/object:Gem::Requirement
49
49
  requirements:
50
50
  - - "~>"
51
51
  - !ruby/object:Gem::Version
52
- version: 1.4.0.rc2
52
+ version: 2.0.alpha1
53
53
  description: Library which provides helpers for easier Karafka consumers tests
54
54
  email:
55
55
  - maciej@mensfeld.pl
@@ -59,28 +59,31 @@ extra_rdoc_files: []
59
59
  files:
60
60
  - ".coditsu/ci.yml"
61
61
  - ".diffend.yml"
62
- - ".github/FUNDING.yml"
63
62
  - ".github/workflows/ci.yml"
64
63
  - ".gitignore"
65
64
  - ".rspec"
66
65
  - ".ruby-gemset"
67
66
  - ".ruby-version"
67
+ - 2.0-Upgrade.md
68
68
  - CHANGELOG.md
69
69
  - Gemfile
70
70
  - Gemfile.lock
71
- - LICENSE
71
+ - MIT-LICENSE
72
72
  - README.md
73
73
  - certs/mensfeld.pem
74
74
  - karafka-testing.gemspec
75
75
  - lib/karafka-testing.rb
76
76
  - lib/karafka/testing.rb
77
+ - lib/karafka/testing/dummy_client.rb
77
78
  - lib/karafka/testing/errors.rb
78
79
  - lib/karafka/testing/rspec/helpers.rb
80
+ - lib/karafka/testing/rspec/proxy.rb
79
81
  - lib/karafka/testing/version.rb
80
- homepage: https://github.com/karafka/testing
82
+ homepage: https://karafka.io
81
83
  licenses:
82
- - LGPL-3.0
83
- metadata: {}
84
+ - MIT
85
+ metadata:
86
+ source_code_uri: https://github.com/karafka/testing
84
87
  post_install_message:
85
88
  rdoc_options: []
86
89
  require_paths:
@@ -89,14 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
89
92
  requirements:
90
93
  - - ">="
91
94
  - !ruby/object:Gem::Version
92
- version: 2.5.0
95
+ version: 2.6.0
93
96
  required_rubygems_version: !ruby/object:Gem::Requirement
94
97
  requirements:
95
- - - ">="
98
+ - - ">"
96
99
  - !ruby/object:Gem::Version
97
- version: '0'
100
+ version: 1.3.1
98
101
  requirements: []
99
- rubygems_version: 3.1.4
102
+ rubygems_version: 3.3.4
100
103
  signing_key:
101
104
  specification_version: 4
102
105
  summary: Library which provides helpers for easier Karafka consumers tests
metadata.gz.sig CHANGED
Binary file
data/.github/FUNDING.yml DELETED
@@ -1 +0,0 @@
1
- open_collective: karafka
data/LICENSE DELETED
@@ -1,165 +0,0 @@
1
- GNU LESSER GENERAL PUBLIC LICENSE
2
- Version 3, 29 June 2007
3
-
4
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
- Everyone is permitted to copy and distribute verbatim copies
6
- of this license document, but changing it is not allowed.
7
-
8
-
9
- This version of the GNU Lesser General Public License incorporates
10
- the terms and conditions of version 3 of the GNU General Public
11
- License, supplemented by the additional permissions listed below.
12
-
13
- 0. Additional Definitions.
14
-
15
- As used herein, "this License" refers to version 3 of the GNU Lesser
16
- General Public License, and the "GNU GPL" refers to version 3 of the GNU
17
- General Public License.
18
-
19
- "The Library" refers to a covered work governed by this License,
20
- other than an Application or a Combined Work as defined below.
21
-
22
- An "Application" is any work that makes use of an interface provided
23
- by the Library, but which is not otherwise based on the Library.
24
- Defining a subclass of a class defined by the Library is deemed a mode
25
- of using an interface provided by the Library.
26
-
27
- A "Combined Work" is a work produced by combining or linking an
28
- Application with the Library. The particular version of the Library
29
- with which the Combined Work was made is also called the "Linked
30
- Version".
31
-
32
- The "Minimal Corresponding Source" for a Combined Work means the
33
- Corresponding Source for the Combined Work, excluding any source code
34
- for portions of the Combined Work that, considered in isolation, are
35
- based on the Application, and not on the Linked Version.
36
-
37
- The "Corresponding Application Code" for a Combined Work means the
38
- object code and/or source code for the Application, including any data
39
- and utility programs needed for reproducing the Combined Work from the
40
- Application, but excluding the System Libraries of the Combined Work.
41
-
42
- 1. Exception to Section 3 of the GNU GPL.
43
-
44
- You may convey a covered work under sections 3 and 4 of this License
45
- without being bound by section 3 of the GNU GPL.
46
-
47
- 2. Conveying Modified Versions.
48
-
49
- If you modify a copy of the Library, and, in your modifications, a
50
- facility refers to a function or data to be supplied by an Application
51
- that uses the facility (other than as an argument passed when the
52
- facility is invoked), then you may convey a copy of the modified
53
- version:
54
-
55
- a) under this License, provided that you make a good faith effort to
56
- ensure that, in the event an Application does not supply the
57
- function or data, the facility still operates, and performs
58
- whatever part of its purpose remains meaningful, or
59
-
60
- b) under the GNU GPL, with none of the additional permissions of
61
- this License applicable to that copy.
62
-
63
- 3. Object Code Incorporating Material from Library Header Files.
64
-
65
- The object code form of an Application may incorporate material from
66
- a header file that is part of the Library. You may convey such object
67
- code under terms of your choice, provided that, if the incorporated
68
- material is not limited to numerical parameters, data structure
69
- layouts and accessors, or small macros, inline functions and templates
70
- (ten or fewer lines in length), you do both of the following:
71
-
72
- a) Give prominent notice with each copy of the object code that the
73
- Library is used in it and that the Library and its use are
74
- covered by this License.
75
-
76
- b) Accompany the object code with a copy of the GNU GPL and this license
77
- document.
78
-
79
- 4. Combined Works.
80
-
81
- You may convey a Combined Work under terms of your choice that,
82
- taken together, effectively do not restrict modification of the
83
- portions of the Library contained in the Combined Work and reverse
84
- engineering for debugging such modifications, if you also do each of
85
- the following:
86
-
87
- a) Give prominent notice with each copy of the Combined Work that
88
- the Library is used in it and that the Library and its use are
89
- covered by this License.
90
-
91
- b) Accompany the Combined Work with a copy of the GNU GPL and this license
92
- document.
93
-
94
- c) For a Combined Work that displays copyright notices during
95
- execution, include the copyright notice for the Library among
96
- these notices, as well as a reference directing the user to the
97
- copies of the GNU GPL and this license document.
98
-
99
- d) Do one of the following:
100
-
101
- 0) Convey the Minimal Corresponding Source under the terms of this
102
- License, and the Corresponding Application Code in a form
103
- suitable for, and under terms that permit, the user to
104
- recombine or relink the Application with a modified version of
105
- the Linked Version to produce a modified Combined Work, in the
106
- manner specified by section 6 of the GNU GPL for conveying
107
- Corresponding Source.
108
-
109
- 1) Use a suitable shared library mechanism for linking with the
110
- Library. A suitable mechanism is one that (a) uses at run time
111
- a copy of the Library already present on the user's computer
112
- system, and (b) will operate properly with a modified version
113
- of the Library that is interface-compatible with the Linked
114
- Version.
115
-
116
- e) Provide Installation Information, but only if you would otherwise
117
- be required to provide such information under section 6 of the
118
- GNU GPL, and only to the extent that such information is
119
- necessary to install and execute a modified version of the
120
- Combined Work produced by recombining or relinking the
121
- Application with a modified version of the Linked Version. (If
122
- you use option 4d0, the Installation Information must accompany
123
- the Minimal Corresponding Source and Corresponding Application
124
- Code. If you use option 4d1, you must provide the Installation
125
- Information in the manner specified by section 6 of the GNU GPL
126
- for conveying Corresponding Source.)
127
-
128
- 5. Combined Libraries.
129
-
130
- You may place library facilities that are a work based on the
131
- Library side by side in a single library together with other library
132
- facilities that are not Applications and are not covered by this
133
- License, and convey such a combined library under terms of your
134
- choice, if you do both of the following:
135
-
136
- a) Accompany the combined library with a copy of the same work based
137
- on the Library, uncombined with any other library facilities,
138
- conveyed under the terms of this License.
139
-
140
- b) Give prominent notice with the combined library that part of it
141
- is a work based on the Library, and explaining where to find the
142
- accompanying uncombined form of the same work.
143
-
144
- 6. Revised Versions of the GNU Lesser General Public License.
145
-
146
- The Free Software Foundation may publish revised and/or new versions
147
- of the GNU Lesser General Public License from time to time. Such new
148
- versions will be similar in spirit to the present version, but may
149
- differ in detail to address new problems or concerns.
150
-
151
- Each version is given a distinguishing version number. If the
152
- Library as you received it specifies that a certain numbered version
153
- of the GNU Lesser General Public License "or any later version"
154
- applies to it, you have the option of following the terms and
155
- conditions either of that published version or of any later version
156
- published by the Free Software Foundation. If the Library as you
157
- received it does not specify a version number of the GNU Lesser
158
- General Public License, you may choose any version of the GNU Lesser
159
- General Public License ever published by the Free Software Foundation.
160
-
161
- If the Library as you received it specifies that a proxy can decide
162
- whether future versions of the GNU Lesser General Public License shall
163
- apply, that proxy's public statement of acceptance of any version is
164
- permanent authorization for you to choose that version for the
165
- Library.