Skip to content

Commit

Permalink
Add ChefRuby/RequireNetHttps
Browse files Browse the repository at this point in the history
Catch anywhere we're still doing this.

Signed-off-by: Tim Smith <tsmith@chef.io>
  • Loading branch information
tas50 committed Aug 24, 2020
1 parent 5cd4e61 commit c5bd062
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 1 deletion.
7 changes: 6 additions & 1 deletion config/chefstyle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -650,4 +650,9 @@ ChefRuby/GemspecRequireRubygems:
Enabled: true
VersionAdded: '1.3.0'
Include:
- '**/*.gemspec'
- '**/*.gemspec'

ChefRuby/RequireNetHttps:
Description: net/http is deprecated and just includes net/http and openssl. We should include those directly instead
Enabled: true
VersionAdded: '1.3.0'
54 changes: 54 additions & 0 deletions lib/rubocop/cop/chef/ruby/require_net_https.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 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 ChefRuby
# net/http is deprecated and just includes net/http and openssl. We should include those directly instead.
#
# @example
#
# # bad
# require 'net/https'
#
# # good
# require 'net/http'
# require 'openssl'
#
class RequireNetHttps < Base
extend RuboCop::Cop::AutoCorrector

MSG = "net/http is deprecated and just includes net/http and openssl. We should include those directly instead."

def_node_matcher :require_net_https?, <<-PATTERN
(send nil? :require (str "net/https"))
PATTERN

def on_send(node)
require_net_https?(node) do
add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
corrector.replace(node, %Q{require "net/http"\nrequire "openssl"})
end
end
end
end
end
end
end
end
39 changes: 39 additions & 0 deletions spec/rubocop/cop/chef/ruby/require_net_https_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 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::ChefRuby::RequireNetHttps, :config do
subject(:cop) { described_class.new(config) }

it "registers an offense when when requiring net/https" do
expect_offense(<<~RUBY)
require 'net/https'
^^^^^^^^^^^^^^^^^^^ net/http is deprecated and just includes net/http and openssl. We should include those directly instead.
RUBY

expect_correction(<<~RUBY)
require "net/http"
require "openssl"
RUBY
end

it "doesn't register an offense when requiring net/http" do
expect_no_offenses("require 'net/http'")
end
end

0 comments on commit c5bd062

Please sign in to comment.