DAND-43-Add scripts for monorepo automation #9

OllaAshour · 2020-01-14T01:09:13Z

What does this PR do?
-Add script to install any missing/required tools and dependencies
-Add gem files to maintain same environment for all developers
-Clean project
-Run pod install/update
-Test project
-Run OCLint checks
-Add clang-format to format objective c code.

To Use

Please run check.sh to make sure all dependencies are installed either within the scripts directory or from parent directory using ./start.sh sh check.sh
Then run ./start.sh sh update.sh to install and update pods.
Then run ./start.sh sh test.sh to make sure all tests have passed
Then run ./start.sh sh lint.sh xxxx to lint, and to clean before building and linting.
xxxx is target name. ./start.sh sh lint.sh Segment-Firebase
and to format, run./start.sh sh format.sh

Associated JIRA Tickets:
https://segmentcontractors.atlassian.net/browse/DAND-47

(cherry picked from commit 1a37cc1)

(cherry picked from commit a9e9759)

(cherry picked from commit fdddd74)

(cherry picked from commit 2ac07da)

…ting using clang-format to lint script (cherry picked from commit cb64570)

(cherry picked from commit 9b614ae)

(cherry picked from commit c9db69c)

(cherry picked from commit a925117)

(cherry picked from commit 6f4925d)

(cherry picked from commit 083fa14)

(cherry picked from commit cb526cf)

briemcnally · 2020-01-14T01:40:25Z

@OllaAshour So I ran
1..start.sh
2. update.sh
3. check.sh

Those all look good. The ./lint.sh is printing that it generated ton of errors for me. You mentioned it is related to path in podspec. Can you update this so we can observer correct behavior or the linter?

Also the ./test.sh command is not running the tests still on this PR. From root directory I get the error:

xcodebuild: error: The directory /Users/brienne.mcnally/dev/src/github.com/segmentio does not contain an Xcode project, workspace or package.

Within the Scripts directory I get this error for .test.sh:

note: Using new build system
note: Planning build
note: Constructing build description
error: Signing for "Segment-FacebookTests" requires a development team. Select a development team in the Signing & Capabilities editor. (in target 'Segment-FacebookTests' from project 'Segment-Facebook')


Test session results, code coverage, and logs:
	/Users/brienne.mcnally/Library/Developer/Xcode/DerivedData/iOS-Integrations-azkshnsjcihbcrcfkrqvixhoinrq/Logs/Test/Test-Segment-Facebook-2020.01.13_17-39-49--0800.xcresult

Testing failed:
	Signing for "Segment-FacebookTests" requires a development team. Select a development team in the Signing & Capabilities editor.
	Testing cancelled because the build failed.

** TEST FAILED **

…how to submit a PR and what is required before submitting a PR

briemcnally · 2020-01-14T17:55:35Z

README.md

+4- OCLint
+5- Clang-format
+
+Alternatively, run .check.sh to install any missing local dependencies.


Can we add a comment this needs to be ran from within the Scripts directory?

I'll add a note here to check "Usage" on how to run the scripts.

briemcnally

Left some comments. Still seems like ./test.sh and ./lint.sh are still not working properly.

If the steps in the Migrating.md are necessary to run the .test.sh we should also include them in them in the READme. In general can we go into more explicit detail on the instructions.

briemcnally · 2020-01-15T17:26:37Z

Guides/Migrating.md

 And run pod install. If successful, running and testing will work correctly. 

-#### 9. In example project, add the newly added destination by setting its relative path.
+#### 9. For tests to compile successfully from command line, code signing for the test targets must be set. (It's enough that it's a personal team, Apple ID does not need to have purchased developer program)


How do we set code signing for the test targets? I am not familiar with this?

Select Target and Go to General, and then Choose Development team.

select Test Target.

briemcnally · 2020-01-15T17:30:07Z

Guides/Migrating.md

-#### 9. In example project, add the newly added destination by setting its relative path.
+#### 9. For tests to compile successfully from command line, code signing for the test targets must be set. (It's enough that it's a personal team, Apple ID does not need to have purchased developer program)
+
+#### 10. It may happen that the pod install has created extra schemes in workspace, simply delete them, but (choose Remove reference) upon delete confirmation.


Can you provide more detail for users unrelated to Xcode projects where they are supposed to be findnig/deleting these extra schems in the workspace. I think if we can make these steps as explicit as possible the better. Ie. Steps like go here in Xcode, Produc -> Scheme -> Edit Scheme and then explicitly state which "extra schemes" the user should be removing or should deem as extra.

briemcnally · 2020-01-15T17:33:30Z

Guides/Migrating.md

+
+#### 10. It may happen that the pod install has created extra schemes in workspace, simply delete them, but (choose Remove reference) upon delete confirmation.
+
+#### 11. It may also happen that the test targets have not been created, in that case, select scheme -> edit scheme ->  test -> +  and it will automatically create a test scheme.


Again once they navigate to test what specifically are they hitting? For me it seems it the test scheme is already enabled so I can't see the workflow for when its not automatically enabled. But can we be as specific as to say be on the Info tab and hit +. Then choose the test target to add to this scheme based off the integration which you just migrated. Again the more explicit here the better.

briemcnally · 2020-01-15T17:36:27Z

Guides/Migrating.md

+
+#### 11. It may also happen that the test targets have not been created, in that case, select scheme -> edit scheme ->  test -> +  and it will automatically create a test scheme.
+
+#### 12. It may also happen that after pod install, all pods are added as targets, in that case, simply select "Manage Schemes" and uncheck all the unrequited targets. (Extra step that will not affect any of the project functionality)


I'm not entirely sure what you mean by the unerquited targets? Here is what my manage schemes looks like for this PR. Can you specify?

Here because I fixed it. But sometimes, you will see e.g "Analytics", "Expecta", are selected, which is not necessary.
We just need the 3 targets we use only.
OCLint is an aggregated target, to show OCLint errors in Xcode rather than command line.
I'll add more info on that.

briemcnally · 2020-01-15T17:39:25Z

Guides/Releasing.md

-#### 5. `git push && git push --tags`.
-#### 6. `pod trunk push xxxx`, where xxxx is the newley added integration podspec.
+##### 1. Update the path of `Source` in the pod spec to point to master branch and change version for next release version.
+##### 2. Run ./lint.sh and .test.ch to make sure no errors detected and all tests pass.


The ./lint.sh command is properly building the project now, the previous PR was not, however the actual linter is printing a ton of errors to the terminal without specific detail.

It looks like a hundred lines of this:

16 errors generated. 16 errors generated. 20 errors generated. 21 errors generated. 16 errors generated. 20 errors generated. 21 errors generated.

Then the actual linter outputs this with no meaningful error log for the error:

Linting pod spec -> Segment-Facebook-App-Events (1.0.4) - WARN | source: Git sources should specify a tag. - WARN | [iOS] license: Unable to find a license file - ERROR | [iOS] xcodebuild: Returned an unsuccessful exit code. You can use `--verbose` for more information. - NOTE | xcodebuild: note: Using new build system - NOTE | [iOS] xcodebuild: note: Planning build - NOTE | [iOS] xcodebuild: note: Constructing build description - NOTE | [iOS] xcodebuild: warning: Capabilities for Signing & Capabilities may not function correctly because its entitlements use a placeholder team ID. To resolve this, select a development team in the App editor. (in target 'App' from project 'App') - NOTE | [iOS] xcodebuild: warning: Skipping code signing because the target does not have an Info.plist file and one is not being generated automatically. (in target 'App' from project 'App') - NOTE | [iOS] xcodebuild: clang: error: linker command failed with exit code 1 (use -v to see invocation) - NOTE | [iOS] xcodebuild: warning: The iOS Simulator deployment target 'IPHONEOS_DEPLOYMENT_TARGET' is set to 7.0, but the range of supported deployment target versions is 8.0 to 13.2.99. (in target 'Analytics' from project 'Pods') [!] Segment-Facebook-App-Events did not pass validation, due to 1 error. You can use the `--no-clean` option to inspect any issue.

briemcnally · 2020-01-15T17:40:42Z

README.md

+We use xcode build tools to run tests. You can run all the tests using:
+```bash
+$ ./test 
+```


This still doesn't seem to be working for me:

❌ error: Signing for "Segment-FacebookTests" requires a development team. Select a development team in the Signing & Capabilities editor. (in target 'Segment-FacebookTests' from project 'Segment-Facebook') Testing failed: Signing for "Segment-FacebookTests" requires a development team. Select a development team in the Signing & Capabilities editor. Testing cancelled because the build failed. ** TEST FAILED ** ❌ error: Signing for "Segment-MixpanelTests" requires a development team. Select a development team in the Signing & Capabilities editor. (in target 'Segment-MixpanelTests' from project 'Segment-Mixpanel') Testing failed: Signing for "Segment-MixpanelTests" requires a development team. Select a development team in the Signing & Capabilities editor. Testing cancelled because the build failed. ** TEST FAILED ** ❌ error: Signing for "Segment-FirebaseTests" requires a development team. Select a development team in the Signing & Capabilities editor. (in target 'Segment-FirebaseTests' from project 'Segment-Firebase') Testing failed: Signing for "Segment-FirebaseTests" requires a development team. Select a development team in the Signing & Capabilities editor. Testing cancelled because the build failed. ** TEST FAILED **

OllaAshour · 2020-01-16T16:28:47Z

README.md

+```
+For the purposes of the guide, we will assume, you are inside the Scripts directory.
+
+1- Please run check.sh to make sure all required dependencies have been installed on machine


@briemcnally I added in Usage how to run within Scripts directory or in root of project.

…ngelog for each of the repos

Also update pods

…tory paths of destinations

OllaAshour · 2020-01-16T20:06:01Z

@briemcnally I have updated the lint script. I think now everything should work correctly. It was because I was including files that should not be linted.
I also updated the lint script to take target name as an argument, to allow linting of any destination.
Also updated README.md and Migrating with the comments

Do kindly test the scripts and hopefully everything works well.

To run lint please do the following ./start.sh sh lint.sh xxxx where xxxx is target name, so e.g it would be ./start.sh sh lint.sh Segment-Firebase

Note: Please add team for the test script to work correctly. Thanks

OllaAshour added 12 commits January 14, 2020 02:53

DAND-43-Add gem file for environment consistencies

6003cc1

(cherry picked from commit 1a37cc1)

DAND-43-Add script for gem dependencies, pod install and update

89cb5b2

(cherry picked from commit a9e9759)

DAND-43- Separate scripts and add scheme checks

e9138b0

DAND-43-Add clang format rules, and for formatting objective c code.

4b633af

(cherry picked from commit fdddd74)

DAND-43-Update scripts to be more user friendly and print status.

6d1658c

(cherry picked from commit 2ac07da)

DAND-43-Added folder for scripts and renamed scipts. Also added forma…

3b8374d

…ting using clang-format to lint script (cherry picked from commit cb64570)

DAND-43-Clean up .check script and gem file

753a491

(cherry picked from commit 9b614ae)

DAND-43-Update Releasing.md guide

f0db566

(cherry picked from commit c9db69c)

DAND-43-update chmod on test.sh and update.sh scripts

6086be3

(cherry picked from commit a925117)

DAND-43-add start.sh to allow scripts to be run from parent directory

98fa2ea

(cherry picked from commit 6f4925d)

DAND-43-remove code signing team from targets

5e17c58

(cherry picked from commit 083fa14)

DAND-43-Update OCLint exclude checks to include Pods directory

d159021

(cherry picked from commit cb526cf)

OllaAshour added 8 commits January 14, 2020 08:55

DAND-43-Move formatting into a separate bash script

ecaa2ac

DAND-43-Run formatting against all code

68c4b1b

DAND-43-Add empty release.sh script for future

2027ca2

DAND-43-Update Readme.md on how to format, lint and test code. Also, …

396b094

…how to submit a PR and what is required before submitting a PR

DAND-43- Add tests checks for mixpanel and firebase targets

5ffc398

DAND-43-Update Migrating document to reflect changes

b8078d1

DAND-43- Update Mixpanel scheme

7acce42

DAND-43-Add command line tool as requirement

6bb99fc

briemcnally reviewed Jan 14, 2020

View reviewed changes

briemcnally suggested changes Jan 15, 2020

View reviewed changes

OllaAshour commented Jan 16, 2020

View reviewed changes

OllaAshour added 5 commits January 16, 2020 18:56

DAND-43-Add license files for facebook, firebase and mixpanel and cha…

712a95a

…ngelog for each of the repos

DAND-43-Update pod file to set all of pod targets as minimum 9.0.

4a0b687

Also update pods

DAND-43-Update lint script to take Targets dynamically and also direc…

69ae9d4

…tory paths of destinations

DAND-43-Update podspec with source destinations

679e27e

DAND-43-Update Simple Example pods

1147a0b

DAND-43-Update guides with comments

d3ac7a0


		#### 10. It may happen that the pod install has created extra schemes in workspace, simply delete them, but (choose Remove reference) upon delete confirmation.

		#### 11. It may also happen that the test targets have not been created, in that case, select scheme -> edit scheme -> test -> + and it will automatically create a test scheme.


		#### 11. It may also happen that the test targets have not been created, in that case, select scheme -> edit scheme -> test -> + and it will automatically create a test scheme.

		#### 12. It may also happen that after pod install, all pods are added as targets, in that case, simply select "Manage Schemes" and uncheck all the unrequited targets. (Extra step that will not affect any of the project functionality)

DAND-43-Add scripts for monorepo automation #9

Are you sure you want to change the base?

DAND-43-Add scripts for monorepo automation #9

Uh oh!

Conversation

OllaAshour commented Jan 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

briemcnally commented Jan 14, 2020

Uh oh!

briemcnally Jan 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

briemcnally left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OllaAshour commented Jan 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

OllaAshour commented Jan 14, 2020 •

edited

Loading

briemcnally Jan 14, 2020 •

edited

Loading

OllaAshour commented Jan 16, 2020 •

edited

Loading