Add a build step which validates each source file for the inclusion of our license header #46

rastersize · 2016-01-26T18:35:15Z

This PR adds a build step which validates that all source files contains our license header. The script did find a few files which where missing it 😄

It also adds Travis-CI group folding to our different steps, to make the output pretties and easier to find.

Credits for the nice little diff command goes to @dflems 🎉

Example output

Validating source files for license compliance…
✓    "demo/AppDelegate.h"
✓    "demo/ClientKeys.h"
✓    "demo/NSString+OAuthBlob.h"
✓    "demo/PlaylistsViewController.h"
✓    "demo/PlaylistsViewModel.h"
✓    "demo/SPTDataLoaderAuthoriserOAuth.h"
✓    "demo/ViewController.h"
✓    "demo/AppDelegate.m"
✓    "demo/NSString+OAuthBlob.m"
✓    "demo/PlaylistsViewController.m"
✓    "demo/PlaylistsViewModel.m"
✓    "demo/SPTDataLoaderAuthoriserOAuth.m"
✓    "demo/ViewController.m"
✓    "demo/main.m"
✓    "include/SPTDataLoader/SPTCancellationToken.h"
✓    "include/SPTDataLoader/SPTDataLoader.h"
✓    "include/SPTDataLoader/SPTDataLoaderAuthoriser.h"
✓    "include/SPTDataLoader/SPTDataLoaderConsumptionObserver.h"
✓    "include/SPTDataLoader/SPTDataLoaderConvenience.h"
✓    "include/SPTDataLoader/SPTDataLoaderDelegate.h"
✓    "include/SPTDataLoader/SPTDataLoaderExponentialTimer.h"
✓    "include/SPTDataLoader/SPTDataLoaderFactory.h"
✓    "include/SPTDataLoader/SPTDataLoaderRateLimiter.h"
✓    "include/SPTDataLoader/SPTDataLoaderRequest.h"
✓    "include/SPTDataLoader/SPTDataLoaderResolver.h"
✓    "include/SPTDataLoader/SPTDataLoaderResponse.h"
✓    "include/SPTDataLoader/SPTDataLoaderService.h"
✓    "SPTDataLoader/NSDictionary+HeaderSize.h"
✓    "SPTDataLoader/SPTCancellationTokenFactory.h"
✓    "SPTDataLoader/SPTCancellationTokenFactoryImplementation.h"
✓    "SPTDataLoader/SPTCancellationTokenImplementation.h"
✓    "SPTDataLoader/SPTDataLoader+Private.h"
✓    "SPTDataLoader/SPTDataLoaderFactory+Private.h"
✓    "SPTDataLoader/SPTDataLoaderRequest+Private.h"
✓    "SPTDataLoader/SPTDataLoaderRequestResponseHandler.h"
✓    "SPTDataLoader/SPTDataLoaderRequestTaskHandler.h"
✓    "SPTDataLoader/SPTDataLoaderResolverAddress.h"
✓    "SPTDataLoader/SPTDataLoaderResponse+Private.h"
✓    "SPTDataLoader/NSDictionary+HeaderSize.m"
✓    "SPTDataLoader/SPTCancellationTokenFactoryImplementation.m"
✓    "SPTDataLoader/SPTCancellationTokenImplementation.m"
✓    "SPTDataLoader/SPTDataLoader.m"
✓    "SPTDataLoader/SPTDataLoaderExponentialTimer.m"
✓    "SPTDataLoader/SPTDataLoaderFactory.m"
✓    "SPTDataLoader/SPTDataLoaderRateLimiter.m"
✓    "SPTDataLoader/SPTDataLoaderRequest.m"
✓    "SPTDataLoader/SPTDataLoaderRequestTaskHandler.m"
✓    "SPTDataLoader/SPTDataLoaderResolver.m"
✓    "SPTDataLoader/SPTDataLoaderResolverAddress.m"
✓    "SPTDataLoader/SPTDataLoaderResponse.m"
✓    "SPTDataLoader/SPTDataLoaderService.m"
✓    "SPTDataLoaderTests/NSURLSessionDataTaskMock.h"
✓    "SPTDataLoaderTests/NSURLSessionMock.h"
✓    "SPTDataLoaderTests/NSURLSessionTaskMock.h"
✓    "SPTDataLoaderTests/SPTCancellationTokenDelegateMock.h"
✓    "SPTDataLoaderTests/SPTDataLoaderAuthoriserMock.h"
✓    "SPTDataLoaderTests/SPTDataLoaderConsumptionObserverMock.h"
✓    "SPTDataLoaderTests/SPTDataLoaderDelegateMock.h"
✓    "SPTDataLoaderTests/SPTDataLoaderRequestResponseHandlerDelegateMock.h"
✓    "SPTDataLoaderTests/SPTDataLoaderRequestResponseHandlerMock.h"
✓    "SPTDataLoaderTests/NSDictionaryHeaderSizeTest.m"
✓    "SPTDataLoaderTests/NSURLSessionDataTaskMock.m"
✓    "SPTDataLoaderTests/NSURLSessionMock.m"
✓    "SPTDataLoaderTests/NSURLSessionTaskMock.m"
✓    "SPTDataLoaderTests/SPTCancellationTokenDelegateMock.m"
✓    "SPTDataLoaderTests/SPTCancellationTokenFactoryImplementationTest.m"
✓    "SPTDataLoaderTests/SPTCancellationTokenImplementationTest.m"
✓    "SPTDataLoaderTests/SPTDataLoaderAuthoriserMock.m"
✓    "SPTDataLoaderTests/SPTDataLoaderConsumptionObserverMock.m"
✓    "SPTDataLoaderTests/SPTDataLoaderDelegateMock.m"
✓    "SPTDataLoaderTests/SPTDataLoaderExponentialTimerTest.m"
✓    "SPTDataLoaderTests/SPTDataLoaderFactoryTest.m"
✓    "SPTDataLoaderTests/SPTDataLoaderRateLimiterTest.m"
✓    "SPTDataLoaderTests/SPTDataLoaderRequestResponseHandlerDelegateMock.m"
✓    "SPTDataLoaderTests/SPTDataLoaderRequestResponseHandlerMock.m"
✓    "SPTDataLoaderTests/SPTDataLoaderRequestTaskHandlerTest.m"
✓    "SPTDataLoaderTests/SPTDataLoaderRequestTest.m"
✓    "SPTDataLoaderTests/SPTDataLoaderResolverAddressTest.m"
✓    "SPTDataLoaderTests/SPTDataLoaderResolverTest.m"
✓    "SPTDataLoaderTests/SPTDataLoaderResponseTest.m"
✓    "SPTDataLoaderTests/SPTDataLoaderServiceTest.m"
✓    "SPTDataLoaderTests/SPTDataLoaderTest.m"

✓ [SUCCESS] All source files contains the required license.

rastersize · 2016-01-27T14:08:52Z

ci/script.sh

+
+# License conformance
+travis_fold_open "License conformance"
+./ci/validate_license_conformance.sh {include/SPTDataLoader/*.h,SPTDataLoader/*.{h,m}}


I put the license validation after the general build actions. However as they run so fast, and they will fail the build, should we have the check before building and test? Wondering if that would make the fail/fix cycle quicker.

Downside to that is that you’d have to fix the license issue (trivial) before you’re even told about potential code failures.

8W9aG · 2016-01-27T14:10:16Z

I'm for putting it before the build, it seems like it is better to fail fast

rastersize · 2016-01-27T14:11:37Z

@8W9aG Ok, I moved it.

rastersize · 2016-01-27T14:13:57Z

This is ready for review @8W9aG @jgavris @dflems 😃

jgavris · 2016-01-27T14:44:38Z

Awesome efforts! I am mostly against merging 'revert' and 'fixup' commits into mainline from a topic branch. How do others feel about squashing into the winner commits?

8W9aG · 2016-01-27T14:50:47Z

I think each to their own on this issue, there are valid arguments for both

rastersize · 2016-01-29T13:25:22Z

@jgavris @8W9aG @dflems Ready for review!

@jgavris I went ahead and squashed the commits a bit. It should be less noisy now. However I left the commits which do separate things separate. Also some commits would have been annoying to squash (specifically squashing 5d0cafa into 838963f) so I left those as-is.
😸

8W9aG · 2016-01-29T13:39:10Z

👍 Very nice

- This was hiding the reason for why our CI script started failing.

- Moves the sections around and groups them a bit more. This way the matrix is at the end of the file. Taking up less visual space and also only messing up the highlighting for itself.

- Quotes! Use quotes liberally when bashing. - Make the travis_fold function take a heading title.

- Also updates existing headers for 2016!

8W9aG · 2016-01-29T13:59:44Z

👍

jgavris · 2016-01-29T14:15:58Z

👍

Add a build step which validates each source file for the inclusion of our license header

rastersize added work in progress ci do not merge labels Jan 26, 2016

rastersize force-pushed the ci/validate-license branch from d19af63 to d181260 Compare January 26, 2016 19:36

rastersize reviewed Jan 27, 2016
View reviewed changes

rastersize added enhancement and removed do not merge work in progress labels Jan 27, 2016

Fix deploy script not being executable

25d1d10

rastersize force-pushed the ci/validate-license branch from 760a77a to 32b4abb Compare January 29, 2016 13:12

Add Travis-CI helper functions

c5a758f

rastersize force-pushed the ci/validate-license branch from 32b4abb to c6e4ca5 Compare January 29, 2016 13:22

rastersize added 7 commits January 29, 2016 14:56

Add source file license validation build job

8a7d9f0

Add Travis group folding for our build steps

eb71279

Move license validation to before build actions

5df0f0b

Tweak Travis-CI group headings and formatting

eb740d1

Add workaround for Travis-CI cut-off logs bug

3aba053

- This was hiding the reason for why our CI script started failing.

Fix Travis matrix config messing up source highlighting

39da8c3

- Moves the sections around and groups them a bit more. This way the matrix is at the end of the file. Taking up less visual space and also only messing up the highlighting for itself.

Fix Travis folds having empty line as heading

a9cdbf6

- Quotes! Use quotes liberally when bashing. - Make the travis_fold function take a heading title.

rastersize force-pushed the ci/validate-license branch from 03d2fae to 28d8166 Compare January 29, 2016 13:56

rastersize added 2 commits January 29, 2016 14:58

Add SPTDataLoaderTests and demo to checked files

0350a23

Add license header to files missing it

ab9ade4

- Also updates existing headers for 2016!

rastersize force-pushed the ci/validate-license branch from 28d8166 to ab9ade4 Compare January 29, 2016 13:58

rastersize added a commit that referenced this pull request Jan 29, 2016

Merge pull request #46 from spotify/ci/validate-license

d532b23

Add a build step which validates each source file for the inclusion of our license header

rastersize merged commit d532b23 into master Jan 29, 2016

rastersize deleted the ci/validate-license branch January 29, 2016 15:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a build step which validates each source file for the inclusion of our license header #46

Add a build step which validates each source file for the inclusion of our license header #46

rastersize commented Jan 26, 2016

rastersize Jan 27, 2016

8W9aG commented Jan 27, 2016

rastersize commented Jan 27, 2016

rastersize commented Jan 27, 2016

jgavris commented Jan 27, 2016

8W9aG commented Jan 27, 2016

rastersize commented Jan 29, 2016

8W9aG commented Jan 29, 2016

8W9aG commented Jan 29, 2016

jgavris commented Jan 29, 2016

Add a build step which validates each source file for the inclusion of our license header #46

Add a build step which validates each source file for the inclusion of our license header #46

Conversation

rastersize commented Jan 26, 2016

Example output

rastersize Jan 27, 2016

Choose a reason for hiding this comment

8W9aG commented Jan 27, 2016

rastersize commented Jan 27, 2016

rastersize commented Jan 27, 2016

jgavris commented Jan 27, 2016

8W9aG commented Jan 27, 2016

rastersize commented Jan 29, 2016

8W9aG commented Jan 29, 2016

8W9aG commented Jan 29, 2016

jgavris commented Jan 29, 2016