A simple app to hit the NY Times Most Popular Articles API and:
- Show a list of articles newest first(sorted based on date)
- Shows details when items on the list are tapped.
- Show Cached articles if network not available
We'll are using the most viewed section of this API. http://api.nytimes.com/svc/mostpopular/v2/mostviewed/{section}/{period}.json?apikey= sample-key To test this API, For testAPI we used
- all-sections for the section path component in the URL
- 7 for period
This is configurable in Constants.Swift file in Project. We used MVVM Design pattern and swift generic approach to develop this application. For CI/CD App using XcodeServer + Fastlane combination.
We are generating TestCase and Coverage report using three tools, you can opt out any one as per your connivance:
- XcodeServer TestCase and Coverage report.
- Fastlane+scan+slather TestCase and Coverage reports.
- SonarQube TestCase and Coverage reports.
App Flow:
- CocoaPods - CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. It has over 33 thousand libraries and is used in over 2.2 million apps. CocoaPods can help you scale your projects elegantly.
- fastlane - The easiest way to automate building and releasing your iOS and Android apps.
- SonarQube - SonarQube provides the capability to not only show health of an application but also to highlight issues newly introduced. With a Quality Gate in place, you can fix the leak and therefore improve code quality systematically.
- SwiftLint - A tool to enforce Swift style and conventions.
- Scan - Scan makes it easy to run tests of your iOS and Mac app on a simulator or connected device.
- Sonar-swift - This is an open source initiative for Apple Swift language support in SonarQube.
- Slather - Generate test coverage reports for Xcode projects & hook it into CI.
- SDWebImage - This library provides an async image downloader with cache support. Reachability.swift is a replacement for Apple's Reachability sample, re-written in Swift with closures.
- ReachabilitySwift - Reachability.swift is a replacement for Apple's Reachability sample, re-written in Swift with closures.
- Sorting option for user to sort article based popularity, Date, Alphabetically
- Refresh articles using pull to refresh or refresh button.
- Configure fastlane lanes/XcodeServerBot for build creation and provising and certificate managment.
- Configure Fastlane lanes for build upload on iTunesConnect.
- Installation by cloning the repository
- Go to directory
- use command + B or Product -> Build to build the project
- Incase of build fail due to dependency SDWebImageView, install SDWebImageView using CocoaPods.
- Incase of build fail due to dependency ReachabilitySwift, install ReachabilitySwift using CocoaPods.
- Press run icon in Xcode or command + R to run the project on Simulator
Xcode Server + Fastlane combination is used for CI/CD. Xcode server bots post script will be used to trigger fastlane lanes. We canrun them using terminal also.
-
Xcode server is setup on local development machine with a new user. Steps for Xcode Server Setup: https://developer.apple.com/library/content/documentation/IDEs/Conceptual/xcode_guide-continuous_integration/index.html
-
Xcode Bot is setup on development machine with git configuration using master branch. Bot run periodically once per-day and configured for the following jobs:
- Pull changes from remote repository if there any .
- Configure to test parallel on specific simulator.
- Run unit test cases.
- Run UI Test cases.
- Run the Static analyser for leaks and warnings.
- Generate the report for UnitTest,UITest,Static analyser on project codebase.
- We did not setup for exporting the build or code-singing for now as iTunes credential required. Once credential is there we can setup these activity by re-edit the XcodeServer Bot .
- Post script for trigger fastlane lanes for screen shot and fastlane+scan code coverage.
To run fastlane lanes configure PATH in XcodeServer Bot configuration under environment tab
PATH="/usr/local/bin:$PATH"
- Error : 0
- Warnings : 0
- Static Analyser issue : 0
- Total TestCase: 13
- Passed : 13
- Failed: 0
- Total TestCase: 13
- Passed : 13
- Failed: 0
- TestCase Code Coverage: 89.72%
Fastlane is setup on Xcode server and integrated in development project also for following activity (Lane):
- Generating TestCase success and code coverage reports using scan and slather.
- Generating screen shot.
- We did not setup code-singing for now as iTunesConnect credential required. Once credential is there we can setup these activity by creating new lane.
- Make sure you have the latest version of the Xcode command line tools installed:
xcode-select --install
-
Install fastlane using gem install fastlane
-
For fastlane test coverage report install scan and slather
-
Install scan using
gem install scan -
Install slather using
gem install slather
-
Run using Terminal
-
Goto project directory $ cd project_directory_path
-
Run command
fastlane screenshotsto capture screen shots. -
Run using Xcode Server trigger with post script
-
Add post script for screen shot in XcodeServer Bot. Bot will trigger post script and screen shot will be generated in Server XCBuildUser.
cd ProjectDir/NYTestApp
fastlane screenshots
- Captured screen shots will be found under path
projectDir/NYTestApp/fastlane/screenshots/en-US - Screen shots report will be found at path
projectDir/NYTestApp/fastlane/screenshots/screenshots.html
-
Run using Terminal
-
Goto project directory $ cd project_directory_path
-
Run command
fastlane teststo capture screen shots. -
Run using Xcode Server trigger with post script
-
Add post script for screen shot in XcodeServer Bot. Bot will trigger post script and screen shot will be generated in Server XCBuildUser.
cd ProjectDir/NYTestApp
fastlane tests
- Coverage report will be found under path
projectDir/NYTestApp/fastlane/test_output/coverage/index.html - TestCase success report will be found under path
projectDir/NYTestApp/fastlane/test_output/report.html
This is also another tool integrated for check project code health reports.
- Install and setup your SonaQube server and other dependency for sonarQube integration with the help of https://github.com/Backelite/sonar-swift or another source.
- Project already contains
run-sonar-swift.shandsonar-project.propertiesin project root folder. - Once your server up, goto project directory and run the sonar-scanner command from terminal.
- After successful scan -
- Use XcodeServer post script to analyses project and test coverage OR
- Run the command from project directory using terminal
$ sh run-sonar-swift.sh - On successful results, open browser and hit
http://localhost:9000/, - You will see the project analyses, Tap on project analyses it will show detail reports
Follow the steps to get test case reports:
- Enable coverage Data under test schema section:
- Select the Test Icon by pressing and holding Xcode Run Icon OR press
Command+Control+U - In the Project Navigator under Test Navigator tab, check test status and coverage
We used MVVM :
Copyright 2018
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.