chore(*): add diagnosis

Author: christhuyenatgrab

lib/cocoapods-binary-cache/diagnosis/base.rb

@@ -0,0 +1,8 @@
+module PodPrebuild
+  class BaseDiagnosis
+    def initialize(options)
+      @cache_validation = options[:cache_validation]
+      @standard_sandbox = options[:standard_sandbox]
+    end
+  end
+end

lib/cocoapods-binary-cache/diagnosis/diagnosis.rb

@@ -0,0 +1,16 @@
+require_relative "base"
+require_relative "integration"
+
+module PodPrebuild
+  class Diagnosis
+    def initialize(options)
+      @diagnosers = [
+        IntegrationDiagnosis
+      ].map { |klazz| klazz.new(options) }
+    end
+
+    def run
+      @diagnosers.each(&:run)
+    end
+  end
+end

lib/cocoapods-binary-cache/diagnosis/integration.rb

@@ -0,0 +1,16 @@
+require_relative "base"
+
+module PodPrebuild
+  class IntegrationDiagnosis < BaseDiagnosis
+    def run
+      integrated = @standard_sandbox.root.glob("*/*.framework").map { |p| p.dirname.basename.to_s }
+      should_be_integrated = if Pod::Podfile::DSL.prebuild_job? \
+                             then @cache_validation.hit + @cache_validation.missed \
+                             else @cache_validation.hit \
+                             end
+      should_be_integrated = should_be_integrated.map { |name| name.split("/")[0] }
+      unintegrated = (should_be_integrated - integrated)
+      Pod::UI.puts "🚩 Unintegrated frameworks: #{unintegrated}".yellow unless unintegrated.empty?
+    end
+  end
+end

lib/cocoapods-binary-cache/env.rb

@@ -0,0 +1,32 @@
+module PodPrebuild
+  class Env
+    @stage_idx = 0
+
+    class << self
+      def reset!
+        @stage_idx = 0
+        @stages = nil
+      end
+
+      def next_stage!
+        @stage_idx += 1 if @stage_idx < stages.count - 1
+      end
+
+      def stages
+        @stages ||= Pod::Podfile::DSL.prebuild_job? ? [:prebuild, :integration] : [:integration]
+      end
+
+      def current_stage
+        stages[@stage_idx]
+      end
+
+      def prebuild_stage?
+        current_stage == :prebuild
+      end
+
+      def integration_stage?
+        current_stage == :integration
+      end
+    end
+  end
+end

lib/cocoapods-binary-cache/hooks/post_install.rb

@@ -5,12 +5,28 @@ def initialize(installer_context)
     end
 
     def run
+      edit_scheme_for_code_coverage if PodPrebuild::Env.prebuild_stage?
+      diagnose if PodPrebuild::Env.integration_stage?
+    end
+
+    private
+
+    def diagnose
+      Pod::UI.section("Diagnosing cocoapods-binary-cache") do
+        PodPrebuild::Diagnosis.new(
+          cache_validation: PodPrebuild::StateStore.cache_validation,
+          standard_sandbox: @installer_context.sandbox
+        ).run
+      end
+    end
+
+    def edit_scheme_for_code_coverage
       return unless Pod::Podfile::DSL.dev_pods_enabled && @installer_context.sandbox.instance_of?(Pod::PrebuildSandbox)
 
       # Modify pods scheme to support code coverage
       # If we don't prebuild dev pod -> no need to care about this in Pod project
       # because we setup in the main project (ex. DriverCI scheme)
-      SchemeEditor.edit_to_support_code_coverage(@installer_context.sandbox) if Pod.is_prebuild_stage
+      SchemeEditor.edit_to_support_code_coverage(@installer_context.sandbox)
     end
   end
 end

lib/cocoapods-binary-cache/hooks/pre_install.rb

@@ -13,8 +13,9 @@ def initialize(installer_context)
     end
 
     def run
+      return if @installer_context.sandbox.is_a?(Pod::PrebuildSandbox)
+
       require_relative "../pod-binary/helper/feature_switches"
-      return if Pod.is_prebuild_stage
 
       log_section "🚀  Prebuild frameworks"
       ensure_valid_podfile
@@ -25,6 +26,8 @@ def run
       Pod::UI.section("Validate prebuilt cache") { validate_cache }
       prebuild! if Pod::Podfile::DSL.prebuild_job?
       reset_environment
+
+      PodPrebuild::Env.next_stage!
       log_section "🤖  Resume pod installation"
       require_relative "../pod-binary/integration"
     end
@@ -54,7 +57,6 @@ def ensure_valid_podfile
 
     def prepare_environment
       Pod::UI.puts "Prepare environment"
-      Pod.is_prebuild_stage = true
       Pod::Podfile::DSL.enable_prebuild_patch true  # enable sikpping for prebuild targets
       Pod::Installer.force_disable_integration true # don't integrate targets
       Pod::Config.force_disable_write_lockfile true # disbale write lock file for perbuild podfile
@@ -63,7 +65,6 @@ def prepare_environment
 
     def reset_environment
       Pod::UI.puts "Reset environment"
-      Pod.is_prebuild_stage = false
       Pod::Installer.force_disable_integration false
       Pod::Podfile::DSL.enable_prebuild_patch false
       Pod::Config.force_disable_write_lockfile false

lib/cocoapods-binary-cache/main.rb

@@ -9,6 +9,7 @@
 require_relative "helper/lockfile"
 require_relative "helper/path_utils"
 require_relative "helper/podspec"
+require_relative "env"
 require_relative "state_store"
 require_relative "hooks/post_install"
 require_relative "hooks/pre_install"
@@ -19,3 +20,4 @@
 require_relative "prebuild_output/metadata"
 require_relative "prebuild_output/output"
 require_relative "scheme_editor"
+require_relative "diagnosis/diagnosis"

lib/cocoapods-binary-cache/pod-binary/helper/feature_switches.rb

@@ -2,10 +2,6 @@
 require_relative "prebuild_sandbox"
 
 module Pod
-
-  # a flag that indicate stages
-  class_attr_accessor :is_prebuild_stage
-
   # a switch for the `pod` DSL to make it only valid for ':binary => true'
   class Podfile
     module DSL

lib/cocoapods-binary-cache/pod-binary/prebuild.rb

@@ -218,7 +218,7 @@ def collect_metadata(target, output_path)
     old_method2 = instance_method(:run_plugins_post_install_hooks)
     define_method(:run_plugins_post_install_hooks) do
       old_method2.bind(self).call
-      prebuild_frameworks! if Pod.is_prebuild_stage && Pod::Podfile::DSL.prebuild_job?
+      prebuild_frameworks! if PodPrebuild::Env.prebuild_stage?
     end
   end
 end

spec/env/env_spec.rb

@@ -0,0 +1,42 @@
+describe "PodPrebuild::Env" do
+  describe "stages" do
+    let(:prebuild_job) { false }
+    before do
+      PodPrebuild::Env.reset!
+      allow(Pod::Podfile::DSL).to receive(:prebuild_job?).and_return(prebuild_job)
+    end
+
+    def expect_current_stage_as(stage)
+      expect(PodPrebuild::Env.current_stage).to eq(stage)
+      expect(PodPrebuild::Env.prebuild_stage?).to be(stage == :prebuild)
+      expect(PodPrebuild::Env.integration_stage?).to be(stage == :integration)
+    end
+
+    context "in a prebuild job" do
+      let(:prebuild_job) { true }
+
+      it "has 2 stages: prebuild and integration" do
+        expect(PodPrebuild::Env.stages).to eq([:prebuild, :integration])
+      end
+
+      it "initially lands on prebuild stage" do
+        expect_current_stage_as(:prebuild)
+      end
+
+      it "transits to integration stage on next" do
+        PodPrebuild::Env.next_stage!
+        expect_current_stage_as(:integration)
+      end
+    end
+
+    context "in a non-prebuild job" do
+      it "has only 1 stage: integration" do
+        expect(PodPrebuild::Env.stages).to eq([:integration])
+      end
+
+      it "initially lands on integration stage" do
+        expect_current_stage_as(:integration)
+      end
+    end
+  end
+end