Merge pull request #2016 from CocoaPods/screenshots

[linter] Validate screenshots are valid

CHANGELOG.md

@@ -20,6 +20,11 @@ To install or update CocoaPods see this [guide](http://docs.cocoapods.org/guides
   [Piet Brauer](https://github.com/pietbrauer)
   [Orta Therox](https://github.com/orta)
 
+* Validate the reachability of screenshot URLs in podspecs while linting a
+  specification.  
+  [Kyle Fuller](https://github.com/kylef)
+  [#2010](https://github.com/CocoaPods/CocoaPods/issues/2010)
+
 ## 0.31.1
 [CocoaPods](https://github.com/CocoaPods/CocoaPods/compare/0.31.1...0.31.0)
 • [CocoaPods-Core](https://github.com/CocoaPods/Core/compare/0.31.1...0.31.0)

lib/cocoapods/validator.rb

@@ -197,6 +197,7 @@ module Pod
     #
     def perform_extensive_analysis(spec)
       validate_homepage(spec)
+      validate_screenshots(spec)
 
       spec.available_platforms.each do |platform|
         UI.message "\n\n#{spec} - Analyzing on #{platform} platform.".green.reversed
@@ -222,22 +223,41 @@ module Pod
     attr_accessor :consumer
     attr_accessor :subspec_name
 
-    # Performs validations related to the `homepage` attribute.
+    # Performs validation of a URL
     #
-    def validate_homepage(spec)
+    def validate_url(url)
       require 'rest'
-      homepage = spec.homepage
-      return unless homepage
 
       begin
-        resp = ::REST.head(homepage)
+        resp = ::REST.head(url)
       rescue
-        warning "There was a problem validating the homepage."
+        warning "There was a problem validating the URL #{url}."
         resp = nil
       end
 
       if resp && !resp.success?
-        warning "The homepage is not reachable."
+        warning "The URL (#{url}) is not reachable."
+      end
+
+      resp
+    end
+
+    # Performs validations related to the `homepage` attribute.
+    #
+    def validate_homepage(spec)
+      if spec.homepage
+        validate_url(spec.homepage)
+      end
+    end
+
+    # Performs validation related to the `screenshots` attribute.
+    #
+    def validate_screenshots(spec)
+      spec.screenshots.each do |screenshot|
+        request = validate_url(screenshot)
+        if request && !(request.headers['content-type'] && request.headers['content-type'].first =~ /image\/.*/i)
+          warning "The screenshot #{screenshot} is not a valid image."
+        end
       end
     end
 

spec/unit/validator_spec.rb

@@ -75,6 +75,7 @@ module Pod
         validator = Validator.new(file)
         validator.quick = true
         validator.stubs(:validate_homepage)
+        validator.stubs(:validate_screenshots)
         validator.validate
         validator.validation_dir.should.be == Pathname.new("/private/tmp/CocoaPods/Lint")
       end
@@ -99,14 +100,41 @@ module Pod
           WebMock::API.stub_request(:head, /not-found/).to_return(:status => 404)
           Specification.any_instance.stubs(:homepage).returns('http://banana-corp.local/not-found/')
           @sut.validate
-          @sut.results.map(&:to_s).first.should.match /The homepage is not reachable/
+          @sut.results.map(&:to_s).first.should.match /The URL (.*) is not reachable/
         end
 
         it "indicates if it was not able to validate the homepage" do
           WebMock::API.stub_request(:head, 'banana-corp.local').to_raise(SocketError)
           Specification.any_instance.stubs(:homepage).returns('http://banana-corp.local/')
           @sut.validate
-          @sut.results.map(&:to_s).first.should.match /There was a problem validating the homepage/
+          @sut.results.map(&:to_s).first.should.match /There was a problem validating the URL/
+        end
+      end
+
+      describe "Screenshot validation" do
+        require 'webmock'
+
+        before do
+          @sut = Validator.new(podspec_path)
+          @sut.stubs(:install_pod)
+          @sut.stubs(:build_pod)
+          @sut.stubs(:check_file_patterns)
+          @sut.stubs(:tear_down_validation_environment)
+          @sut.stubs(:validate_homepage)
+          WebMock::API.stub_request(:head, 'banana-corp.local/valid-image.png').to_return(:status => 200, :headers => { 'Content-Type' => 'image/png' })
+        end
+
+        it "checks if the screenshots are valid" do
+          Specification.any_instance.stubs(:screenshots).returns(['http://banana-corp.local/valid-image.png'])
+          @sut.validate
+          @sut.results.should.be.empty?
+        end
+
+        it "should fail if any of the screenshots URLS do not return an image" do
+          WebMock::API.stub_request(:head, 'banana-corp.local/').to_return(:status => 200)
+          Specification.any_instance.stubs(:screenshots).returns(['http://banana-corp.local/valid-image.png', 'http://banana-corp.local/'])
+          @sut.validate
+          @sut.results.map(&:to_s).first.should.match /The screenshot .* is not a valid image/
         end
       end
 
@@ -114,6 +142,7 @@ module Pod
         file = write_podspec(stub_podspec)
         sut = Validator.new(file)
         sut.stubs(:validate_homepage)
+        sut.stubs(:validate_screenshots)
         sut.no_clean = true
         sut.validate
         sut.validation_dir.should.exist
@@ -123,6 +152,7 @@ module Pod
         file = write_podspec(stub_podspec)
         sut = Validator.new(file)
         sut.stubs(:validate_homepage)
+        sut.stubs(:validate_screenshots)
         sut.expects(:install_pod).twice
         sut.expects(:build_pod).twice
         sut.expects(:check_file_patterns).twice
@@ -132,6 +162,7 @@ module Pod
       it "uses the deployment target of the specification" do
         sut = Validator.new(podspec_path)
         sut.stubs(:validate_homepage)
+        sut.stubs(:validate_screenshots)
         podfile = sut.send(:podfile_from_spec, :ios, '5.0')
         dependency = podfile.target_definitions['Pods'].dependencies.first
         dependency.external_source.has_key?(:podspec).should.be.true
@@ -140,6 +171,7 @@ module Pod
       it "respects the local option" do
         sut = Validator.new(podspec_path)
         sut.stubs(:validate_homepage)
+        sut.stubs(:validate_screenshots)
         podfile = sut.send(:podfile_from_spec, :ios, '5.0')
         deployment_target = podfile.target_definitions['Pods'].platform.deployment_target
         deployment_target.to_s.should == "5.0"
@@ -150,6 +182,7 @@ module Pod
         sut.stubs(:check_file_patterns)
         sut.stubs(:xcodebuild).returns("file.m:1:1: warning: direct access to objective-c's isa is deprecated")
         sut.stubs(:validate_homepage)
+        sut.stubs(:validate_screenshots)
         sut.validate
         first = sut.results.map(&:to_s).first
         first.should.include "[xcodebuild]"
@@ -161,6 +194,7 @@ module Pod
         sut = Validator.new(file)
         sut.stubs(:build_pod)
         sut.stubs(:validate_homepage)
+        sut.stubs(:validate_screenshots)
         sut.validate
         sut.results.map(&:to_s).first.should.match /source_files.*did not match/
         sut.result_type.should == :error
@@ -175,6 +209,7 @@ module Pod
         spec = Specification.from_file(file)
         sut = Validator.new(spec)
         sut.stubs(:validate_homepage)
+        sut.stubs(:validate_screenshots)
         sut.stubs(:build_pod)
         sut.validate
         sut.validated?.should.be.true