elasticsearch-test-runner 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74628e9c64f4c668f6e4ef87c94afa47ee6539b22ab3a28ce4fd25e8ae69d457
-  data.tar.gz: e9fc240ffa3a200f1e3cb257ba73b297145117a75c19c38e4a7194695e3e5ddb
+  metadata.gz: '0271385db599d8551f6a83a8cc3c349fb9e9e419404e2a6551ad1a79a609530b'
+  data.tar.gz: d7c7a28831431f41c3b60b63fa6a0f56ce6683b87bbaabd7531414e3cd45e12b
 SHA512:
-  metadata.gz: 27b6f144c51341b040891a80a23353b328f1378a3ba33503e3dfbe6f6cf86dc501f45717fb4af9a3b7dd72fe8fa21eae2c5ce91d7e4764a7a877e3fd48ef0590
-  data.tar.gz: e94c3308a4733421362d13af89915db5b010ec72d76218ccd7d8efa25a3bf1c8f9e0ea1a19b0e798ba44655b7e8a2df2feab8cc7642c4d97ed1f8aeb353901ff
+  metadata.gz: bf8130ff5fd1161285c9f9c0bcecd545ea10e2c28788febf0e19ff180c3088eec9090b7dc73da0d7902f7c3cef88a0617aa24079ac737ec80e7733662606dfa7
+  data.tar.gz: 296a138149fb4c1fd8388dff6ab0ebcf492daf07650c5b2c5df865d7bf99227dc3b450097474a6c55be2bb511a6bb1e6cc38c93a3358a88a86d357855c880e8f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.11.0] - 2024-12-12
+
+- Adds skipping tests.
+
+## [0.10.1] - 2024-11-13
+
+- Creates directory for tests if it doesn't exist.
+
 ## [0.10.0] - 2024-11-13
 
 - Using tar.gz file for downloaded tests instead of zip file.

data/README.md

@@ -29,6 +29,9 @@ Elasticsearch::Tests::TestRunner.new(client, tests_path).run
 
 [The tests](https://github.com/elastic/elasticsearch-clients-tests) are designed for the Elasticsearch REST API and the Elasticsearch Serverless REST API. If you pass in an `ElasticsearchServerless::Client`, it will only run the tests that have the `requires.serverless: true` statement. Otherwise, it will only run the ones with `requires.stack: true`.
 
+
+### Logging
+
 You can optionally pass in an object that implements Ruby's Logger to the `TestRunner` initializer. This will log more information, particularly useful in the case of errors where it'll log stacktraces for exceptions and more:
 
 ```ruby
@@ -39,6 +42,8 @@ runner = Elasticsearch::Tests::TestRunner.new(client, tests_path, logger)
 runner.run
 ```
 
+### Running particular tests
+
 When you run the tests, you can pass in the name of a particular test or a whole test folder, to run only those tests. Tests in the clients project are located [in the `tests` directory](https://github.com/elastic/elasticsearch-clients-tests/tree/main/tests) either as single yaml files or inside a specific directory, referring to a specific namespace. For example [`tests/get.yml`](https://github.com/elastic/elasticsearch-clients-tests/blob/main/tests/get.yml) and [`tests/bulk/10_basic.yml`](https://github.com/elastic/elasticsearch-clients-tests/blob/main/tests/bulk/10_basic.yml). If you want to run the `get.yml` test, you can pass in the file name to `run`:
 
 ```ruby
@@ -59,6 +64,18 @@ runner.run('indices')
 
 This will run all the tests in [`tests/indices`](https://github.com/elastic/elasticsearch-clients-tests/tree/main/tests/indices) such as `alias.yml`, `analyze.yml`, and so on.
 
+### Skipping tests
+
+If you want to skip any given tests, you can do it using `add_tests_to_skip` before calling `run` like this:
+
+```ruby
+runner.add_tests_to_skip(['bulk/10_basic.yml', 'get.yml'])
+```
+
+You need to pass in an Array of file or folder names, or a single test file as a String.
+
+### Downloading the test suite
+
 You can **download the YAML test files** from [the clients tests project](https://github.com/elastic/elasticsearch-clients-tests) with the following code:
 
 ```ruby

data/lib/elasticsearch/tests/downloader.rb

@@ -52,6 +52,7 @@ module Elasticsearch
         def untar_file(path)
           puts 'Extracting tar files'
           puts path
+          FileUtils.mkdir_p(path) unless File.directory?(path)
           `tar -zxf #{FILENAME} --strip-components=1 -C #{path}/`
           puts 'Removing tar file'
         end

data/lib/elasticsearch/tests/test_runner.rb

@@ -32,6 +32,15 @@ module Elasticsearch
         @serverless = defined?(::ElasticsearchServerless) && client.is_a?(::ElasticsearchServerless::Client)
         @path = path || File.expand_path('./tmp', __dir__)
         @logger = logger || LOGGER
+        @tests_to_skip = []
+      end
+
+      def add_tests_to_skip(tests)
+        if tests.is_a? String
+          @tests_to_skip << tests
+        else
+          @tests_to_skip.merge!(tests)
+        end
       end
 
       def run(test_files = [])
@@ -97,7 +106,13 @@ module Elasticsearch
                      else
                        "#{@path}/#{test_files}/*.yml"
                      end
-        Dir.glob(tests_path)
+        tests = Dir.glob(tests_path)
+        tests.each do |test|
+          @tests_to_skip.each do |skip|
+            tests.delete(test) if test.match?(skip)
+          end
+        end
+        tests
       end
 
       def extract_requires!(yaml)

data/lib/elasticsearch/tests/version.rb

@@ -19,6 +19,6 @@
 
 module Elasticsearch
   module Tests
-    VERSION = '0.10.0'
+    VERSION = '0.11.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-test-runner
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2024-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch