Support Swift Package Manager #126

bfernandesbfs · 2020-05-10T22:01:05Z

Support Swift Package Manager

Add support to SPM

Changed

Add Package.swift
Project folders organization for compatibility to structure Swift Package Manager
Fix Headers Objc
Change load resource into test target

bfernandesbfs · 2020-05-10T22:06:25Z

Hi @alanzeino!

Can you analyse this PR?
I'm fixed quantity of changes to better code review and reduce impact of move files

alanzeino · 2020-05-11T02:55:10Z

.gitignore

 Pods
+Podfile.lock


I don't think this is needed

I revert this

alanzeino · 2020-05-11T02:59:05Z

FBSnapshotTestCase/Categories/UIImage+Compare.m

@@ -28,7 +28,11 @@
 //  OTHER DEALINGS IN THE SOFTWARE.
 //

+#if SWIFT_PACKAGE


Why can't a SwiftPM project use angle bracket imports? Does it not support Header Search Paths?

Objective-C has this in common with C/C++; the quoted form is for "local" includes of files (you need to specify the relative path from the current file, e.g. #include "headers/my_header.h"), while the angle-bracket form is for "global" includes -- those found somewhere on the include path passed to the compiler (e.g. #include <math.h>) and SPM use local path

alanzeino · 2020-05-11T03:00:21Z

FBSnapshotTestCase/FBSnapshotTestCase.m

@@ -7,8 +7,8 @@
 *
 */

-#import <FBSnapshotTestCase/FBSnapshotTestCase.h>
-#import <FBSnapshotTestCase/FBSnapshotTestController.h>
+#import "Public/FBSnapshotTestCase.h"


Curious about this change; can we not specify which files are Public and Internal via the Package.swift?

I try specify, but in Package.swift the property publicHeadersPath: have an unique path for file .h and conflict with file .swift

alanzeino · 2020-05-11T03:02:02Z

FBSnapshotTestCase/Support/SwiftSupport.swift

+import XCTest
+
+#if SWIFT_PACKAGE
+@_exported import FBSnapshotTestCaseCore


I think this is a private Swift feature and not one we should use

We need exported the public header of submodules, this case we can use only this in test target

why can't people just import FBSnapshotTestCaseCore if they need it?

in this case FBSnapshotTestCaseCore is a private module

alanzeino · 2020-05-11T03:07:13Z

FBSnapshotTestCaseTests/FBSnapshotControllerTests.m

+    NSURL *url = [[NSURL fileURLWithPath: @__FILE__] URLByDeletingLastPathComponent];
+    NSString *path = [[url URLByAppendingPathComponent: [NSString stringWithFormat:@"%@.%@", name, type]] path];


I'm assuming this is because the image isn't visible in the bundle? Is there a better way to do this because this seems like a hack that finds the temp directory storing the code file and using that path to find the image. Was bundle nil before?

Yes, today it's not possible load bundle resource in the SPM, but has open issue in swift .org about this. I' created this hack as temp solution, if bundle fail we can see in the unit test

Might be worth adding a comment in the code explaining that?

I read file with using reserved key __FILE__, this create relative path from file test

A comment in the code linking to the open issue would be suffice

We can bundle resources in swift packages now https://developer.apple.com/documentation/swift_packages/bundling_resources_with_a_swift_package

NickEntin · 2020-05-21T20:46:16Z

FBSnapshotTestCaseDemo/Podfile.lock

@@ -1,20 +0,0 @@
-PODS:


I don't think the Podfile.lock should be deleted

yeah it's used in the demo because the demo is a real app depending on FBSnapshotTestCase, therefore it needs a Podfile and a Podfile.lock

NickEntin · 2020-05-21T20:48:59Z

FBSnapshotTestCaseTests/FBSnapshotControllerTests.m

+    NSURL *url = [[NSURL fileURLWithPath: @__FILE__] URLByDeletingLastPathComponent];
+    NSString *path = [[url URLByAppendingPathComponent: [NSString stringWithFormat:@"%@.%@", name, type]] path];


Might be worth adding a comment in the code explaining that?

jsorge · 2020-09-08T18:27:55Z

It's been 3+ months since the last activity here. Is this still being considered for merging?

ralewis85 · 2020-10-30T02:30:02Z

Heading into November with no update @alanzeino

alanzeino · 2020-11-07T00:01:06Z

Heading into November with no update @alanzeino

I can't merge anything in this repo anymore, I asked the team at Uber to move the repo to my ownership but didn't hear back (other than telling me to fork it).

When I worked to get ownership of FBSnapshotTestCase from Facebook to Uber back in the day, I had to fork and churn every user of the repo with a new podspec, cocoapod name, etc. If I forked this today, everyone would have to do that again, and it's just not worth it. My wish is that Uber transfer me this repo since they don't maintain it anymore, but they have might their reasons to keep it (cc @briankhsieh), and I don't work there anymore so I don't have much influence on that part. Funny thing is now I work at Facebook I could resurrect the original repo, but it would be madness to make everyone churn their podspec back to the original...

My advice? Use the pointfree snapshot library. If you have Objective-C needs then you don't need SwiftPM support anyway, since I don't think SwiftPM supports Objective-C anyway?

liuxuan30 · 2020-12-08T07:36:18Z

My advice? Use the pointfree snapshot library

Could you share more steps to do so? Not understand how to get the latest update.

Besides is there anything we can do to help you get back the repo? It's ridiculous for Uber to take this repo as a hostage...

alanzeino · 2020-12-11T20:32:06Z

My advice? Use the pointfree snapshot library

Could you share more steps to do so? Not understand how to get the latest update.

https://github.com/pointfreeco/swift-snapshot-testing

liuxuan30 · 2020-12-14T03:22:29Z

My advice? Use the pointfree snapshot library

Could you share more steps to do so? Not understand how to get the latest update.

https://github.com/pointfreeco/swift-snapshot-testing

Thanks, it is a new library. I'm still want to keep the current one though. Anything we could do to help you to get back the repo?

liuxuan30 · 2020-12-14T03:23:48Z

I'm hoping @briankhsieh could see this. If you could either help to transfer the ownship or you update it. Thank you.

liuxuan30 · 2020-12-14T03:26:56Z

@alanzeino

Funny thing is now I work at Facebook I could resurrect the original repo, but it would be madness to make everyone churn their podspec back to the original...

It might be easier just to change a podspec. The point is this is a great library, I think people would like to do the change again once they understand the situation here. It will be a pity that we loose this library only because you cannot get the repo and people don't want to churn.

alanzeino · 2020-12-17T01:05:32Z

Why don't you download the source of the PR (https://github.com/bfernandesbfs/ios-snapshot-test-case/tree/feature/spm) to your repo and then reference the package in your Package.swift with a relative path .package(url: "Vendor/iOSSnapshotTestCase")

I haven't tried this but it should work and unblock you from having iOSSnapshotTestCase in SwiftPM

alanzeino · 2021-03-18T05:11:44Z

Update: I'm working again on getting ownership of the repo again. In the meantime, I'm developing on the project again on my fork:

https://github.com/alanzeino/ios-snapshot-test-case

I've merged in @bfernandesbfs' changes and I'm testing them now. Hopefully within the month I'll have the ability to maintain this repo again and I'll merge my fork back into here.

bfernandesbfs · 2021-03-18T13:56:39Z

Great news \o/

…an be manually set to the root folder where reference images are stored, which is needed for Swift Package Manager. After this change there are now 4 ways of setting reference image directories instead of 3: 1. Set the preprocessor macro FB_REFERENCE_IMAGE_DIR to a double quoted c-string with the path. This only works for Objective-C tests. 2. Set an environment variable named FB_REFERENCE_IMAGE_DIR with the path. This takes precedence over the preprocessor macro to allow for run-time override. 3. (New way) Set `FBSnapshotTestCase.bundleResourcePath` as the root folder where reference images are stored. 4. Keep everything unset, which will cause the reference images to be looked up inside the bundle holding the current test, in the Resources/ReferenceImages_* directories.

ianrhamilton · 2021-05-20T09:59:14Z

@alanzeino how's it going with the ownership transfer?

…undleresourcepath Added bundleResourcePath variable to FBSnapshotTestController which c…

dogo · 2021-06-09T18:46:33Z

@alanzeino how's it going with the ownership transfer?

alanzeino · 2021-06-09T18:52:27Z

Should know more in a few weeks

dogo · 2021-08-25T03:22:17Z

🥳

alanzeino · 2021-08-25T20:36:43Z

For anyone needing this you can now use this via your Package.swift as so:

.package(url: "https://github.com/uber/ios-snapshot-test-case.git", from: "7.0.0")

or via Xcode:

https://github.com/uber/ios-snapshot-test-case/blob/main/README.md#swift-package-manager

bfernandesbfs · 2021-08-25T22:59:00Z

Hey @alanzeino thanks by you help with this PR 🙌🏻🎉

bfernandesbfs added 4 commits May 10, 2020 18:59

Add support Swift Package Manager

a4539d0

Update Readme

5bffe20

FIx import header

d08f252

Export import dependecy submodule core

c318994

alanzeino reviewed May 11, 2020

View reviewed changes

Remove Pods.lock .gitignore

a745ec0

This was referenced May 20, 2020

Not support Swift Package Manager (SPM) #91

Closed

Swift Package Manager Support ashfurrow/Nimble-Snapshots#190

Closed

NickEntin reviewed May 21, 2020

View reviewed changes

alanzeino mentioned this pull request Nov 7, 2020

Is this library already deprecated? #136

Closed

1ec5 mentioned this pull request Feb 16, 2021

Migrate snapshot tests away from unmaintained testing frameworks mapbox/mapbox-navigation-ios#2791

Closed

Merge pull request #1 from atlassian-forks/feature/spm-manually-set-b…

1a951ce

…undleresourcepath Added bundleResourcePath variable to FBSnapshotTestController which c…

tahirmt mentioned this pull request Jun 14, 2021

Add support for swift package manager ashfurrow/Nimble-Snapshots#215

Closed

alanzeino merged commit 6466926 into uber:master Aug 23, 2021

alanzeino added a commit that referenced this pull request Aug 24, 2021

Revert the Podfile.lock removal from #126

9c71a14

alanzeino added a commit that referenced this pull request Aug 24, 2021

Update podspec after public headers move in #126

6743a70

		NSURL *url = [[NSURL fileURLWithPath: @__FILE__] URLByDeletingLastPathComponent];
		NSString *path = [[url URLByAppendingPathComponent: [NSString stringWithFormat:@"%@.%@", name, type]] path];

Support Swift Package Manager #126

Support Swift Package Manager #126

Conversation

bfernandesbfs commented May 10, 2020

Support Swift Package Manager

Changed

bfernandesbfs commented May 10, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bfernandesbfs May 13, 2020 • 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

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsorge commented Sep 8, 2020

ralewis85 commented Oct 30, 2020

alanzeino commented Nov 7, 2020

liuxuan30 commented Dec 8, 2020 • edited Loading

alanzeino commented Dec 11, 2020

liuxuan30 commented Dec 14, 2020 • edited Loading

liuxuan30 commented Dec 14, 2020

liuxuan30 commented Dec 14, 2020 • edited Loading

alanzeino commented Dec 17, 2020 • edited Loading

alanzeino commented Mar 18, 2021

bfernandesbfs commented Mar 18, 2021

ianrhamilton commented May 20, 2021

dogo commented Jun 9, 2021

alanzeino commented Jun 9, 2021

dogo commented Aug 25, 2021

alanzeino commented Aug 25, 2021 • edited Loading

bfernandesbfs commented Aug 25, 2021

bfernandesbfs May 13, 2020 •

edited

Loading

liuxuan30 commented Dec 8, 2020 •

edited

Loading

liuxuan30 commented Dec 14, 2020 •

edited

Loading

liuxuan30 commented Dec 14, 2020 •

edited

Loading

alanzeino commented Dec 17, 2020 •

edited

Loading

alanzeino commented Aug 25, 2021 •

edited

Loading