kitchen-transport-express 1.0.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
+ SHA256:
3
+ metadata.gz: 7eaabe4263ef01558a60d4e50ded08beb48bfa5ffae332ed529e37c766e829dd
4
+ data.tar.gz: e9f4c574a1feacffd6a25267e4e347c1003f93f8cc24714afd0d9ea849790e4d
5
+ SHA512:
6
+ metadata.gz: 18efa1a554ee66e71f00ad612755cc1a214cc84cc496b486d437a4d617659e403fe79c3228188a8e9544e32b78170dc807174d265f9cb01da67e385270fb2e1f
7
+ data.tar.gz: b090fb3c75e893596947f406b9425b10f30288b86f81c4f918516838fed9890082ca5227e2cb428dd205a35df45f66ba09d827727eab75f1013c2a2e30e2d562
@@ -0,0 +1,38 @@
1
+ # This workflow uses actions that are not certified by GitHub.
2
+ # They are provided by a third-party and are governed by
3
+ # separate terms of service, privacy policy, and support
4
+ # documentation.
5
+ # This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
6
+ # For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
7
+
8
+ name: Ruby
9
+
10
+ on:
11
+ pull_request:
12
+ branches: [ "master" ]
13
+
14
+ permissions:
15
+ contents: read
16
+
17
+ jobs:
18
+ test:
19
+
20
+ runs-on: ubuntu-latest
21
+ strategy:
22
+ matrix:
23
+ ruby-version: ['2.3', '2.5', '2.7', '3.0', '3.1']
24
+
25
+ steps:
26
+ - uses: actions/checkout@v4
27
+ - name: Set up Ruby
28
+ # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
29
+ # change this to (see https://github.com/ruby/setup-ruby#versioning):
30
+ uses: ruby/setup-ruby@v1
31
+ with:
32
+ ruby-version: ${{ matrix.ruby-version }}
33
+ rubygems: 3.2.3
34
+ bundler-cache: true # runs 'bundle install' and caches installed gems automatically
35
+ - name: Run Style Check
36
+ run: bundle exec rake style
37
+ - name: Run Unit Tests
38
+ run: bundle exec rake test
data/.gitignore ADDED
@@ -0,0 +1,38 @@
1
+ *.gem
2
+ *.lock
3
+ *.rbc
4
+ /.config
5
+ /coverage/
6
+ /InstalledFiles
7
+ /pkg/
8
+ /spec/reports/
9
+ /spec/examples.txt
10
+ /test/tmp/
11
+ /test/version_tmp/
12
+ /tmp/
13
+
14
+ ## Specific to RubyMotion:
15
+ .dat*
16
+ .repl_history
17
+ build/
18
+
19
+ ## Documentation cache and generated files:
20
+ /.yardoc/
21
+ /_yardoc/
22
+ /doc/
23
+ /rdoc/
24
+
25
+ ## Environment normalization:
26
+ /.bundle/
27
+ /vendor/bundle
28
+ /lib/bundler/man/
29
+
30
+ # for a library or gem, you might want to ignore these files since the code is
31
+ # intended to run in multiple environments; otherwise, check them in:
32
+ # Gemfile.lock
33
+ # .ruby-version
34
+ # .ruby-gemset
35
+
36
+ # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
37
+ .rvmrc
38
+ .idea
data/.rubocop.yml ADDED
@@ -0,0 +1,26 @@
1
+ AllCops:
2
+ NewCops: enable
3
+ Layout/LineLength:
4
+ Max : 150
5
+ Metrics/AbcSize:
6
+ Enabled : true
7
+ # setting a max size here to match current standards so old ruby environments don't fail in the pipeline
8
+ Max : 17
9
+ Metrics/BlockLength:
10
+ Enabled : true
11
+ Exclude:
12
+ - 'spec/**/*'
13
+ Metrics/BlockNesting:
14
+ Enabled : true
15
+ Metrics/ClassLength:
16
+ Enabled : true
17
+ Metrics/CyclomaticComplexity:
18
+ Enabled : true
19
+ Metrics/MethodLength:
20
+ Enabled : true
21
+ Metrics/ModuleLength:
22
+ Enabled : true
23
+ Metrics/ParameterLists:
24
+ Enabled : true
25
+ Metrics/PerceivedComplexity:
26
+ Enabled : true
data/Gemfile ADDED
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright:: 2025 Justin Steele <justin.steele@oracle.com>
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ source "https://rubygems.org"
18
+
19
+ 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,52 @@
1
+ # Kitchen::Transport::Express
2
+
3
+ `kitchen-transport-express` is a plugin for `Kitchen::Transport` that is designed to dramatically improve the time to converge nodes over SSH. This gem was inspired by projects
4
+ like [kitchen-transport-speedy](https://github.com/criteo/kitchen-transport-speedy) and [kitchen-sync](https://github.com/coderanger/kitchen-sync).
5
+
6
+ The main improvement that `kitchen-transport-express` offers is it does not use native commands like `tar`, `rsync`, `stfp`, etc. to package and transfer the files. By using the libraries
7
+ included in a `chef-workstation` installation to create the tarballs, `kitchen-transport-express` is able to provide the same performance improvement to developers who are working on either a
8
+ Linux/Mac-based system or on a Windows system.
9
+
10
+ # Installation
11
+
12
+ To get started, run `chef gem install kitchen-transport-express`.
13
+
14
+ Modify the `transport` section of the `kitchen.yml` for your Linux hosts to reference the `express_ssh` module.
15
+
16
+ ```yaml
17
+ transport:
18
+ name: express_ssh
19
+ ```
20
+
21
+ Verify that everything has loaded correctly with `kitchen list`. You should see `ExpressSsh` as the transport.
22
+
23
+ ```bash
24
+ > kitchen list ─╯
25
+ Instance Driver Provisioner Verifier Transport Last Action Last Error
26
+ default-linux Oci ChefInfra Inspec ExpressSsh <Not Created> <None>
27
+ ```
28
+
29
+ # Windows Kitchen Instances
30
+
31
+ Windows kitchen instances natively uses the `WinRM::FS::Core::FileTransporter` class to transfer files and it already performs the same zip-and-ship process that `kitchen-transport-express` offers
32
+ to SSH instances. As such, there is no module in this gem for `WinRM`. You should continue using the built-in transport for your Windows instances.
33
+
34
+ ```yaml
35
+ transport:
36
+ name: winrm
37
+ ```
38
+
39
+ # Contributing
40
+
41
+ Bug reports and pull requests are welcome on [GitHub](https://github.com/justintsteele/kitchen-transport-express.git)
42
+
43
+ # License
44
+
45
+ Copyright 2025, Justin Steele
46
+
47
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
48
+
49
+ http://www.apache.org/licenses/LICENSE-2.0
50
+
51
+ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
52
+ See the License for the specific language governing permissions and limitations under the License.
data/Rakefile ADDED
@@ -0,0 +1,41 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright:: 2025 Justin Steele <justin.steele@oracle.com>
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ require "bundler/gem_tasks"
18
+ require "rspec/core/rake_task"
19
+ require "rubygems/package"
20
+
21
+ RSpec::Core::RakeTask.new(:test)
22
+
23
+ spec_path = Dir.glob(File.join(File.dirname(__FILE__), "*.gemspec")).first
24
+ spec = Gem::Specification.load(spec_path)
25
+ gemfile = "pkg/#{spec.name}-#{spec.version}.gem"
26
+
27
+ begin
28
+ require "chefstyle"
29
+ require "rubocop/rake_task"
30
+ RuboCop::RakeTask.new(:style) do |task|
31
+ task.options += ["--display-cop-names"]
32
+ end
33
+ rescue LoadError
34
+ puts "chefstyle is not available. (sudo) gem install chefstyle to do style checking."
35
+ end
36
+
37
+ task :build do
38
+ Gem::Package.build(spec, nil, nil, gemfile)
39
+ end
40
+
41
+ task default: %i{style test}
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright:: 2025 Justin Steele <justin.steele@oracle.com>
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ lib = File.expand_path("lib", __dir__)
18
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
19
+ require "kitchen/transport/express/version"
20
+
21
+ Gem::Specification.new do |spec|
22
+ spec.name = "kitchen-transport-express"
23
+ spec.version = Kitchen::Transport::Express::VERSION
24
+ spec.authors = ["Justin Steele"]
25
+ spec.email = ["justin.steele@oracle.com"]
26
+ spec.summary = %q{Skip the long lines in transport. 15 items or less!}
27
+ spec.description = %q{A Test Kitchen Transport plugin that streamlines the file transfer phase to Linux hosts.}
28
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
29
+ spec.homepage = "https://github.com/justintsteele/kitchen-transport-express.git"
30
+ spec.license = "Apache-2.0"
31
+ spec.require_paths = ["lib"]
32
+ spec.add_dependency "test-kitchen"
33
+ spec.add_dependency "ffi-libarchive"
34
+ spec.add_development_dependency "bundler"
35
+ spec.add_development_dependency "rake"
36
+ spec.add_development_dependency "rspec"
37
+ end
@@ -0,0 +1,99 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright:: 2025 Justin Steele <justin.steele@oracle.com>
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ require "ffi-libarchive"
18
+
19
+ module Kitchen
20
+ module Transport
21
+ class Express
22
+ module Archiver
23
+ def archive(path)
24
+ archive_basename = ::File.basename(path) + ".tgz"
25
+ archive_full_name = ::File.join(::File.dirname(path), archive_basename)
26
+
27
+ file_count = ::Dir.glob(::File.join(path, "**/*")).size
28
+ logger.debug("[#{LOG_PREFIX}] #{path} contains #{file_count} files.")
29
+ create_archive(path, archive_full_name)
30
+ archive_full_name
31
+ end
32
+
33
+ def extract(archive_basename, remote)
34
+ logger.debug("[#{LOG_PREFIX}] Unpacking archive #{archive_basename} in #{remote}")
35
+ execute("tar -xzf #{::File.join(remote, archive_basename)} -C #{remote}")
36
+ execute("rm -f #{::File.join(remote, archive_basename)}")
37
+ end
38
+
39
+ private
40
+
41
+ def create_archive(path, archive_path)
42
+ Archive.write_open_filename(archive_path, Archive::COMPRESSION_GZIP,
43
+ Archive::FORMAT_TAR_PAX_RESTRICTED) do |tar|
44
+ write_content(tar, path)
45
+ end
46
+ end
47
+
48
+ def write_content(tar, path)
49
+ all_files = Dir.glob("#{path}/**/*")
50
+ all_files.each do |f|
51
+ tar.new_entry do |e|
52
+ entry(e, f, path)
53
+ tar.write_header e
54
+ tar.write_data content(f) if File.file? f
55
+ end
56
+ end
57
+ end
58
+
59
+ def entry(ent, file, path)
60
+ ent.pathname = path_name(file, path)
61
+ ent.size = size(file) if File.file? file
62
+ ent.mode = mode(file)
63
+ ent.filetype = file_type(file)
64
+ ent.atime = timestamp
65
+ ent.mtime = timestamp
66
+ end
67
+
68
+ def path_name(file, path)
69
+ file.gsub(%r{#{File.dirname(path)}/}, "")
70
+ end
71
+
72
+ def file_type(file)
73
+ if File.file? file
74
+ Archive::Entry::FILE
75
+ elsif File.directory? file
76
+ Archive::Entry::DIRECTORY
77
+ end
78
+ end
79
+
80
+ def content(file)
81
+ File.read file unless File.directory? file
82
+ end
83
+
84
+ def size(file)
85
+ content(file).size
86
+ end
87
+
88
+ def mode(file)
89
+ f = File.stat(file)
90
+ f.mode
91
+ end
92
+
93
+ def timestamp
94
+ Time.now.to_i
95
+ end
96
+ end
97
+ end
98
+ end
99
+ end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright:: 2025 Justin Steele <justin.steele@oracle.com>
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ module Kitchen
18
+ module Transport
19
+ class Express
20
+ VERSION = "1.0.0"
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright:: 2025 Justin Steele <justin.steele@oracle.com>
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ require "kitchen/transport/ssh"
18
+ require_relative "express/version"
19
+ require_relative "express/archiver"
20
+
21
+ module Kitchen
22
+ module Transport
23
+ LOG_PREFIX = "EXPRESS"
24
+
25
+ class ExpressSsh < Kitchen::Transport::Ssh
26
+ kitchen_transport_api_version 1
27
+ plugin_version Express::VERSION
28
+
29
+ def create_new_connection(options, &block)
30
+ if @connection
31
+ logger.debug("[#{LOG_PREFIX}] Shutting previous connection #{@connection}")
32
+ @connection.close
33
+ end
34
+
35
+ @connection_options = options
36
+ @connection = self.class::Connection.new(options, &block)
37
+ end
38
+
39
+ def verifier_defined?(instance)
40
+ defined?(Kitchen::Verifier::Inspec) && instance.verifier.is_a?(Kitchen::Verifier::Inspec)
41
+ end
42
+
43
+ def finalize_config!(instance)
44
+ return unless verifier_defined?(instance)
45
+
46
+ super.tap do
47
+ instance.verifier.send(:define_singleton_method, :runner_options_for_expressssh) do |config_data|
48
+ runner_options_for_ssh(config_data)
49
+ end
50
+ end
51
+ end
52
+
53
+ class Connection < Kitchen::Transport::Ssh::Connection
54
+ include Express::Archiver
55
+
56
+ def upload(locals, remote)
57
+ return super unless valid_remote_requirements?
58
+
59
+ Array(locals).each do |local|
60
+ if ::File.directory?(local)
61
+ archive = archive(local)
62
+ ensure_remote_dir_exists(remote)
63
+ end
64
+ logger.debug("[#{LOG_PREFIX}] Uploading #{File.basename(archive || local)} to #{remote}")
65
+ super(archive || local, remote)
66
+ extract(File.basename(archive), remote) if archive
67
+ end
68
+ end
69
+
70
+ def valid_remote_requirements?
71
+ execute("(which tar && which gzip) > /dev/null")
72
+ true
73
+ rescue => e
74
+ logger.debug("[#{LOG_PREFIX}] Requirements not met on remote host for Express transport.")
75
+ logger.debug(e)
76
+ false
77
+ end
78
+
79
+ def ensure_remote_dir_exists(remote)
80
+ execute("mkdir -p #{remote}")
81
+ end
82
+ end
83
+ end
84
+ end
85
+ end
metadata ADDED
@@ -0,0 +1,125 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: kitchen-transport-express
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Justin Steele
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2025-01-27 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: test-kitchen
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: ffi-libarchive
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: A Test Kitchen Transport plugin that streamlines the file transfer phase
84
+ to Linux hosts.
85
+ email:
86
+ - justin.steele@oracle.com
87
+ executables: []
88
+ extensions: []
89
+ extra_rdoc_files: []
90
+ files:
91
+ - ".github/workflows/ruby.yml"
92
+ - ".gitignore"
93
+ - ".rubocop.yml"
94
+ - Gemfile
95
+ - LICENSE
96
+ - README.md
97
+ - Rakefile
98
+ - kitchen-transport-express.gemspec
99
+ - lib/kitchen/transport/express/archiver.rb
100
+ - lib/kitchen/transport/express/version.rb
101
+ - lib/kitchen/transport/express_ssh.rb
102
+ homepage: https://github.com/justintsteele/kitchen-transport-express.git
103
+ licenses:
104
+ - Apache-2.0
105
+ metadata: {}
106
+ post_install_message:
107
+ rdoc_options: []
108
+ require_paths:
109
+ - lib
110
+ required_ruby_version: !ruby/object:Gem::Requirement
111
+ requirements:
112
+ - - ">="
113
+ - !ruby/object:Gem::Version
114
+ version: '0'
115
+ required_rubygems_version: !ruby/object:Gem::Requirement
116
+ requirements:
117
+ - - ">="
118
+ - !ruby/object:Gem::Version
119
+ version: '0'
120
+ requirements: []
121
+ rubygems_version: 3.3.7
122
+ signing_key:
123
+ specification_version: 4
124
+ summary: Skip the long lines in transport. 15 items or less!
125
+ test_files: []