Introduce `test_specification` DSL #369

dnkoutso · 2017-03-25T05:32:26Z

I'd like to re-open the "project" for adding test support to CocoaPods.

We have 100s of projects that we typically end up having to include a <ProjectName>Tests.xcodeproj that includes all of our test sources and a Podfile that integrates it with the pod locally.

I've chatted with @orta and @benasher44 on bringing this back. It would be awesome for podspecs to become more self-contained and when consumed as development pods the Pods.xcodeproj can create a test bundle target to include test sources so you can run them.

We are also heavy users of development pods in our main project causing us to create multiple xcodeproj just to support our tests for pods we will never publish which also complicates CI further.

This is the first PR that brings back the DSL to include a test_spec.

We won't be going super advanced on this to begin with. Test specs should create a test bundle target in the Pods.xcodeproj and include the test sources. The validator should also be updated to run the tests if a test_spec is present before publishing a pod. If no test_spec is specified everything should continue to work the way it is today.

dnkoutso · 2017-03-25T05:35:21Z

CHANGELOG.md

-* None.  
+* Introduce `test_specification` DSL  
+  [Dimitris Koutsogiorgas](https://github.com/dnkoutso)
+  [Kyle Fuller](https://github.com/kylef)


Most of the work was done so I included the credit.

dnkoutso · 2017-03-25T05:42:25Z

lib/cocoapods-core/specification/dsl.rb

+      #   end
+      #
+      def test_spec(&block)
+        subspec = Specification.new(self, 'Tests', true, &block)


@benasher44 do you think we should force the name to always be 'Tests' or let podspec authors to configure it? This means that each spec (including root) can have 1 and only 1 test spec right?

To avoid future DSL gotchas: it's worth considering about making sure a test target can be configured to support multiple test targets, for example you might have unit tests + uiintegration tests (we do in Eigen, but we don't in any of our libs FWIW)

You might not have to do the work today, but building the DSL in a way that supports that is 👍

@orta good point. Having a test spec is one thing but there is no way to configure it to generate a UI test target or a unit test target. Do those differ much?

They differ considerably in implementation (one is a bundle injected into an app target, the other an app target)

dnkoutso · 2017-03-25T05:44:00Z

Additional cool thing could easily be a small plugin command that generates the xcodeproj for developers.

This means a developer can clone a repo and through the podspec generate the xcodeproj to develop on the pod. This means no more xcodeproj checked in to the repo which means no more ugly conflicts.

dnkoutso · 2017-03-28T04:01:56Z

lib/cocoapods-core/specification.rb

-    # @param  [Bool] all_platforms
-    #         whether the dependencies should be returned for all platforms
-    #         instead of the active one.
+    # @param  [Platform] platform


Fixed documentation for this method.

endocrimes

This is a really good start, excited for this to land 👍

endocrimes · 2017-04-13T13:00:32Z

lib/cocoapods-core/specification/dsl.rb

+      #     end
+      #   end
+      #
+      def test_spec(&block)


This should maybe be:

def test_spec(name = 'Tests', type = :unit, &block)

or similar to allow for extension into different test target types in the future.

dnkoutso · 2017-04-14T15:55:39Z

Will rebase and resume this a bit this weekend. still high on my radar for 1.3.0.

dnkoutso · 2017-04-21T01:52:08Z

@orta @dantoml getting closer can you take another look?

dnkoutso · 2017-04-21T02:01:20Z

spec/specification/dsl_spec.rb

+        @spec = Spec.new do |spec|
+          spec.name = 'Spec'
+          spec.test_spec do |test_spec|
+            test_spec.test_type = :unit


@orta @dantoml if I a podspec author does not call this, how can I enforce a default value? Is it on the Specification constructor that I add test_spec = :unit if test_specification or something akin to that?

added it in the initializer of Specification.rb

Removed it now as the attribute now has a default_value set when used with a consumer.rb.

orta · 2017-04-21T02:35:21Z

This looks like what I'd expect it to look like 👍

dnkoutso · 2017-04-21T22:10:06Z

I think its ready!

dnkoutso · 2017-04-22T00:37:02Z

lib/cocoapods-core/specification/dsl.rb

+      #
+      # @param  [Symbol] type
+      #         The test type to use.
+      attribute :test_type,


@orta @dantoml I am reading the code more I dont think :keys is what we want here so I removed it. Keys is meant to be used to validate the keys within a hash value, not for limiting the potential values you can have for this attribute.

Instead the Linter takes care of validating the value is correct, which I added a test for.

dnkoutso · 2017-04-22T01:44:45Z

@orta @dantoml alright I think its finally ready.

dnkoutso · 2017-04-22T02:37:26Z

lib/cocoapods-core/specification/dsl.rb

+      # @param  [Symbol] type
+      #         The test type to use.
+      attribute :test_type,
+                :default_value => :unit,


Turns out this exists!

dnkoutso · 2017-04-22T02:59:56Z

Very excited for this

orta · 2017-04-23T17:58:31Z

👍

dnkoutso · 2017-04-23T21:16:15Z

@dantoml @orta with your blessing I can merge.

endocrimes

dnkoutso · 2017-04-24T14:17:20Z

Merging! Lets this party started.

dnkoutso force-pushed the test_spec_dsl branch 2 times, most recently from 33f0b21 to 448f753 Compare March 25, 2017 05:34

dnkoutso commented Mar 25, 2017

View reviewed changes

benasher44 mentioned this pull request Mar 26, 2017

Does CocoaPods have plans to add public headers generating process? CocoaPods/CocoaPods#6580

Closed

1 task

dnkoutso force-pushed the test_spec_dsl branch 2 times, most recently from c91dfa4 to 0464159 Compare March 28, 2017 03:57

dnkoutso commented Mar 28, 2017

View reviewed changes

dnkoutso force-pushed the test_spec_dsl branch from 0464159 to 9096262 Compare March 30, 2017 18:27

dnkoutso force-pushed the test_spec_dsl branch from 9096262 to 7b061d7 Compare April 8, 2017 03:42

endocrimes mentioned this pull request Apr 13, 2017

Create xctest target using cocoapods CocoaPods/CocoaPods#6649

Closed

endocrimes reviewed Apr 13, 2017

View reviewed changes

dnkoutso force-pushed the test_spec_dsl branch 4 times, most recently from 278c88b to ff2bf56 Compare April 21, 2017 01:50

dnkoutso commented Apr 21, 2017

View reviewed changes

dnkoutso force-pushed the test_spec_dsl branch from ff2bf56 to 35cec78 Compare April 21, 2017 02:09

dnkoutso force-pushed the test_spec_dsl branch 3 times, most recently from 9d7a63c to fab2c45 Compare April 21, 2017 22:09

dnkoutso force-pushed the test_spec_dsl branch 4 times, most recently from 5e55185 to 08dc711 Compare April 22, 2017 00:21

dnkoutso force-pushed the test_spec_dsl branch from 08dc711 to 117eabd Compare April 22, 2017 00:36

dnkoutso commented Apr 22, 2017

View reviewed changes

dnkoutso force-pushed the test_spec_dsl branch 6 times, most recently from cc50e76 to 6ecbf89 Compare April 22, 2017 01:44

Introduce test_specification DSL

a2e106b

dnkoutso force-pushed the test_spec_dsl branch from 6ecbf89 to a2e106b Compare April 22, 2017 02:31

dnkoutso commented Apr 22, 2017

View reviewed changes

endocrimes approved these changes Apr 24, 2017

View reviewed changes

dnkoutso merged commit 75fd14f into CocoaPods:master Apr 24, 2017

dnkoutso mentioned this pull request May 9, 2017

Add test reference to xcscheme if target is of type test CocoaPods/Xcodeproj#485

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce `test_specification` DSL #369

Introduce `test_specification` DSL #369

dnkoutso commented Mar 25, 2017 •

edited

Loading

dnkoutso Mar 25, 2017

dnkoutso Mar 25, 2017

orta Mar 25, 2017

dnkoutso Mar 28, 2017

orta Mar 28, 2017

dnkoutso commented Mar 25, 2017

dnkoutso Mar 28, 2017

endocrimes left a comment

endocrimes Apr 13, 2017

dnkoutso commented Apr 14, 2017

dnkoutso commented Apr 21, 2017

dnkoutso Apr 21, 2017 •

edited

Loading

dnkoutso Apr 21, 2017 •

edited

Loading

dnkoutso Apr 22, 2017

orta commented Apr 21, 2017

dnkoutso commented Apr 21, 2017

dnkoutso Apr 22, 2017 •

edited

Loading

dnkoutso Apr 22, 2017

dnkoutso commented Apr 22, 2017

dnkoutso Apr 22, 2017

dnkoutso commented Apr 22, 2017

orta commented Apr 23, 2017

dnkoutso commented Apr 23, 2017

endocrimes left a comment

dnkoutso commented Apr 24, 2017

Introduce test_specification DSL #369

Introduce test_specification DSL #369

Conversation

dnkoutso commented Mar 25, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnkoutso commented Mar 25, 2017

Choose a reason for hiding this comment

endocrimes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnkoutso commented Apr 14, 2017

dnkoutso commented Apr 21, 2017

dnkoutso Apr 21, 2017 • edited Loading

Choose a reason for hiding this comment

dnkoutso Apr 21, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orta commented Apr 21, 2017

dnkoutso commented Apr 21, 2017

dnkoutso Apr 22, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnkoutso commented Apr 22, 2017

Choose a reason for hiding this comment

dnkoutso commented Apr 22, 2017

orta commented Apr 23, 2017

dnkoutso commented Apr 23, 2017

endocrimes left a comment

Choose a reason for hiding this comment

dnkoutso commented Apr 24, 2017

Introduce `test_specification` DSL #369

Introduce `test_specification` DSL #369

dnkoutso commented Mar 25, 2017 •

edited

Loading

dnkoutso Apr 21, 2017 •

edited

Loading

dnkoutso Apr 21, 2017 •

edited

Loading

dnkoutso Apr 22, 2017 •

edited

Loading