-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a cop for detecting legacy powershell methods
We shouldn't use these anywhere now that we have the improved methods Signed-off-by: Tim Smith <tsmith@chef.io>
- Loading branch information
Showing
2 changed files
with
81 additions
and
0 deletions.
There are no files selected for viewing
36 changes: 36 additions & 0 deletions
36
lib/rubocop/cop/chef/ruby/legacy_powershell_out_methods.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# frozen_string_literal: true | ||
# | ||
# Copyright:: Chef Software, Inc. | ||
# Author:: Tim Smith (<tsmith@chef.io>) | ||
# | ||
# 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 | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# 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. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
# | ||
|
||
module RuboCop | ||
module Cop | ||
module Chef | ||
module Ruby | ||
# Use powershell_exec!/powershell_exec instead of powershell_out!/powershell_out. The new | ||
# methods don't spawn 2 shells per shellout and instead use .NET bindings to call PS directly. | ||
class LegacyPowershellOutMethods < Base | ||
MSG = "Use powershell_exec!/powershell_exec instead of the slower legacy powershell_out!/powershell_out methods." | ||
RESTRICT_ON_SEND = %i{powershell_out! powershell_out}.freeze | ||
|
||
def on_send(node) | ||
add_offense(node, message: MSG, severity: :refactor) | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end |
45 changes: 45 additions & 0 deletions
45
spec/rubocop/cop/chef/ruby/legacy_powershell_out_methods_spec.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# frozen_string_literal: true | ||
# | ||
# Copyright:: Chef Software, Inc. | ||
# Author:: Tim Smith (<tsmith@chef.io>) | ||
# | ||
# 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 | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# 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. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
# | ||
|
||
require "spec_helper" | ||
|
||
describe RuboCop::Cop::Chef::Ruby::LegacyPowershellOutMethods, :config do | ||
subject(:cop) { described_class.new(config) } | ||
|
||
it "registers an offense when using powershell_out!" do | ||
expect_offense(<<~RUBY) | ||
powershell_out!('foo') | ||
^^^^^^^^^^^^^^^^^^^^^^ Use powershell_exec!/powershell_exec instead of the slower legacy powershell_out!/powershell_out methods. | ||
RUBY | ||
end | ||
|
||
it "registers an offense when using powershell_out" do | ||
expect_offense(<<~RUBY) | ||
powershell_out('foo') | ||
^^^^^^^^^^^^^^^^^^^^^ Use powershell_exec!/powershell_exec instead of the slower legacy powershell_out!/powershell_out methods. | ||
RUBY | ||
end | ||
|
||
it "doesn't register an when using powershell_exec" do | ||
expect_no_offenses("powershell_exec('foo')") | ||
end | ||
|
||
it "doesn't register an when using powershell_exec!" do | ||
expect_no_offenses("powershell_exec!('foo')") | ||
end | ||
end |