Carthage: OpenCV2 Issues

[arturgrigor]

• carthage install method: [ ] .pkg, [x] homebrew, [ ] source
• which carthage: /usr/local/bin/carthage
• carthage version: 0.30.1
• xcodebuild -version: Xcode 9.4.1 (Build version 9F2000)
• Are you using --no-build? No
• Are you using --no-use-binaries? No
• Are you using --use-submodules? No
• Are you using --cache-builds? No
• Are you using --new-resolver? No

Cartfile

binary "opencv2.json"

opencv2.json

{
    "3.4.3": "https://github.com/opencv/opencv/releases/download/3.4.3/opencv-3.4.3-ios-framework.zip"
}

Command ran

carthage update

Carthage Output

*** Downloading binary-only framework opencv2 at "file:///Users/arturgrigor/Downloads/test/opencv2.json"
*** Downloading binary-only framework opencv2 at "file:///Users/arturgrigor/Downloads/test/opencv2.json"
*** xcodebuild output can be found in /var/folders/4l/1fk2vc_13m1b4bf4bwcjc3z80000gn/T/carthage-xcodebuild.eBZDi3.log
Failed to read file or folder at /Users/arturgrigor/Downloads/test/Carthage/Build/iOS/opencv2.framework

Actual outcome
Carthage did not finish successfully.

Expected outcome
Carthage should just download the framework and finish. I don't see why extra steps are needed in this case as long as the project builds perfectly with the downloaded framework as-is.

[ikesyo]

This may be already addressed in #2542; we need to check that for what platform a framework is built (to copy into appropriate Carthage/Build/$platform subdirectory).

[tmspzz]

I think this might have something to do with a problem @jdhealy looked at. My memory fails me right now.

[ikesyo]

I examined that the Info.plist in that framework actually does not contain CFBundleExecutable key, so I believe this is already fixed on master (by #2542). Closing.

[arturgrigor]

I manually added the CFBundleExecutable entry in the Info.plist but now the process is stuck elsewhere, in the Copy Frameworks Build Phase.

Stripping the framework seems to break something in the codesign.

Copy Frameworks build phase output

A shell task (/usr/bin/xcrun codesign --force --sign - --preserve-metadata=identifier,entitlements /Users/arturgrigor/Library/Developer/Xcode/DerivedData/SomeApp-drffgqdfqwopeicnuknmmqlifxzk/Build/Products/Debug-iphonesimulator/SomeApp.app/Frameworks/opencv2.framework) failed with exit code 1:
/Users/arturgrigor/Library/Developer/Xcode/DerivedData/SomeApp-drffgqdfqwopeicnuknmmqlifxzk/Build/Products/Debug-iphonesimulator/SomeApp.app/Frameworks/opencv2.framework: replacing existing signature
/Users/arturgrigor/Library/Developer/Xcode/DerivedData/SomeApp-drffgqdfqwopeicnuknmmqlifxzk/Build/Products/Debug-iphonesimulator/SomeApp.app/Frameworks/opencv2.framework: bundle format is ambiguous (could be app or framework)

But manually running the codesign command with the original framework from the Carthage/Builds folder seems to work just fine. This is the output of that:

/usr/bin/xcrun codesign --force --sign - --preserve-metadata=identifier,entitlements Carthage/Build/iOS/opencv2.framework
Carthage/Build/iOS/opencv2.framework: replacing existing signature

[tmspzz]

@arturgrigor please use master. brew install carthage HEAD

[arturgrigor]

@blender The master version seems to fix the carthage update issue but is not helping with the carthage copy-frameworks command.

* Copy Frameworks build phase output*

A shell task (/usr/bin/xcrun codesign --force --sign - --preserve-metadata=identifier,entitlements /Users/arturgrigor/Library/Developer/Xcode/DerivedData/SomeApp-drffgqdfqwopeicnuknmmqlifxzk/Build/Products/Debug-iphonesimulator/SomeApp.app/Frameworks/opencv2.framework) failed with exit code 1:
/Users/arturgrigor/Library/Developer/Xcode/DerivedData/SomeApp-drffgqdfqwopeicnuknmmqlifxzk/Build/Products/Debug-iphonesimulator/SomeApp.app/Frameworks/opencv2.framework: unsealed contents present in the root directory of an embedded framework

[tmspzz]

Are you trying with the binary you have manually added the plist key to or with a new binary? Please use an untouched binary as downloaded from the url you have provided. The error usually indicates that you have a file that is not supposed to be in the framework bundle.

I am trying to repro but I can't even get it to link properly, so I'm just run codesign manually and I don't have any issues with the downloaded binary.

[arturgrigor]

@blender I tried with the untouched version. But for easier debugging, I created this test project so you can take a look at it. https://www.dropbox.com/s/l2kxf2qz485jl8w/OpenCV%20Carthage%20Test.zip?dl=0

Just download the ZIP, run carthage update and then open the project in Xcode and do a build. You'll see that the build fails and the output should look like this

A shell task (/usr/bin/xcrun codesign --force --sign - --preserve-metadata=identifier,entitlements /Users/arturgrigor/Library/Developer/Xcode/DerivedData/OpenCV_Carthage_Test-djapmviaolqhvyhkmnqgwvqjikab/Build/Products/Debug-iphonesimulator/OpenCV\ Carthage\ Test.app/Frameworks/opencv2.framework) failed with exit code 1:
/Users/arturgrigor/Library/Developer/Xcode/DerivedData/OpenCV_Carthage_Test-djapmviaolqhvyhkmnqgwvqjikab/Build/Products/Debug-iphonesimulator/OpenCV Carthage Test.app/Frameworks/opencv2.framework: unsealed contents present in the root directory of an embedded framework

Command /bin/sh failed with exit code 1

[tmspzz]

The binary that is downloaded is __crafted by hand__ and contains not one, but __two__ .DS_Store in it.

This is the first problem.
The second problem I believe has to do with the bundle structure, but I'm still trying to figure out what is wrong.

[tmspzz]

Quick fix, don't include this framework in the carthage-copy frameworks list

[arturgrigor]

I see. Ok, but if I don't include it in the copy frameworks build phase then the framework won't get copied to the "Frameworks" folder so it won't be available at runtime.

[tmspzz]

If you include it in Linked Libraries and Frameworks and Xcode will copy it

[ikesyo]

Linked Libraries and Frameworks

No, that is just for linking but not for copying frameworks. "Embedded Binaries" should be what you mean.

[tmspzz]

@ikesyo Right, but I just checked a project of mine and it worked without that. I am wondering why now :D

[tmspzz]

I think I know why. Because these frameworks are static.

[tmspzz]

So yeah, sorry for the stream of consciousness but I just realized that there is nothing to copy here by definition so you should not be using copy-frameworks

I spent like __a day__ debugging this when I should have immediately realized it was supposed to be statically linked.

🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️🤦‍♂️

[tmspzz]

I think it might be appropriate to enhance copy-frameworks to detect Mach-O types and reject static frameworks printing a notice that it will skip the item.

[arturgrigor]

@blender As far as I know that's only true for static libraries but in my case this is a dynamic framework and technically, it needs to be copied to the Frameworks folder. But... I modified that sample project that I linked earlier and actually used the opencv dependency in a view controller and it runs without issues, so no crash as I expected at app launch.

So it makes me wonder why is that? Is it possible because the framework is written in C++ and it doesn't need the Objective-C runtime? 🤔

[arturgrigor]

I will run more tests in different environments and I'll post here an update if the framework needs to be listed in the "Embedded Binaries" section or not.

[ikesyo]

but in my case this is a dynamic framework

I examined that the framework included in https://github.com/opencv/opencv/releases/download/3.4.3/opencv-3.4.3-ios-framework.zip is actually a static one.

$ objdump -macho -private-header -non-verbose opencv2 
Archive : opencv2
Mach header
      magic cputype cpusubtype  caps    filetype ncmds sizeofcmds      flags
 0xfeedfacf 16777223          3  0x00           1     4        672 0x00002000
...

All filetypes are 1 and that is MH_OBJECT, so the framework is static (dynamic library will be 6/MH_DYLIB).

[tmspzz]

@arturgrigor it's just packaged as a framework, but it's a static library and Xcode knows it :)

[arturgrigor]

@ikesyo Wow, that's right. I just analyzed the Mach-O header and it says that the file is a static library. That makes a lot of sense for why the app didn't crash at runtime given the fact that the dependency wasn't embedded.

[arturgrigor]

Thanks guys for your time on this! 🙇

[tmspzz]

@ikesyo just out of curiosity what is your process to check if it's a static lib?

[tmspzz]

Ok we're using the same command.

[ikesyo]

@blender Yes, the command used at https://github.com/Carthage/Carthage/issues/2567#issuecomment-420379968 comes from https://github.com/Carthage/Carthage/blob/9192623a0487dd88e855ca1df91cb11249b8b695/Source/CarthageKit/MachHeader.swift#L67-L75 😉

[ikesyo]

Let's close this again.