Setting Up CircleCI Workflows for Your Salesforce Apps
- 1. Setting Up CircleCI Workflows for Your Salesforce Apps
- 2. Daniel Stange Technical Architect DIA die.interaktiven GmbH & Co. KG Frankfurt, Germany User Group Leader You can find me at: Twitter: @stangomat Blog: blog.danielstange.de
- 3. Agenda • Prerequisites • Why CI? • Basics & Concepts • Design our workflow • Run our workflow • Add some QA measures • Where to head next?
- 4. Sample Project Find the repo at github.com/dstdia/CircleCI-Webinar
- 6. PREREQUISITES What do you need to start? • Salesforce DX Developer Hub (your Prod or a trial dev hub org) • A distributed version control system. Github or Bitbucket are great • The Salesforce CLI (basically: download and install the Salesforce DX package on your computer)
- 7. FIRST STEPS • Checkout my repo from http://bit.ly/SFDX_CircleCI • Sign up for a CircleCI trial: https://circleci.com/ (single sign-on with Github or Bitbucket)
- 8. 2 WHY CI
- 9. WHY CI? Extra effort - to save time and effort • Structured Change Process: Repeatable, automated, transparent • Find bugs and flaws • Deploy more often and earlier • Reduce the effort to collect and deploy changes • Reduce deployment failures • Promote agile / iterative approach • Introduce QA steps
- 10. WHY PUT THE EFFORT IN A CI WORKFLOW? Test Automation Deployment Automation Development Lifecycle
- 11. Increase Quality More and better testing less failing deployment
- 12. WHY SFDX and Circle CI? • SFDX is the new default toolchain to manage Salesforce customizations • Circle CI integrates seamlessly by SSO with Bitbucket or Github… • the entry tier is free… and for open source, you’ll get a powerful set of containers for parallel builds • (relatively) easy to configure • Building workflows for building cloud software by using cloud software is not just recursive… • … but a great approach to tie in the exact tool at the exact moment you need it (e.g. static code analysis with Apex PMD or Clayton.io)
- 13. DEMO
- 15. SFDX ORCHESTRATION sfdx force:org:create sfdx force:source:push sfdx force:apex:test:run sfdx force:source:convert sfdx force:mdapi:deploy • Create an org • Install your source • Run tests • Convert to Metadata format • Deploy to target
- 18. DEMO
- 20. Building our flow PLANNING • What should happen? When and why? • Which environments do you need? When and why? • Understand the structure of the CircleCI config and map your plan to config items
- 21. Building our flow STEPS • Test in isolation • Verify the code quality • If both finish successfully, and if we had (merge) commit to the master branch, deploy to our target org
- 22. Building our flow STEPS • Install the Salesforce CLI • Connect to our dev hub • Create a scratch org, push and test • Install and run PMD • Connect to our target and deploy if we are in the master branch
- 23. Building our flow STEPS tests pmd-check deploy Prepare Salesforce DX Prepare Salesforce DX Prepare Salesforce DX Create Org Prepare Apex PMD Push Code Convert Source Convert Source Run Project Tests Run Apex PMD Deploy with Local Tests
- 24. Building our flow STEPS tests pmd-check Deploy (master branch) Prepare Salesforce DX Create Org Prepare Apex PMD Push Code Convert Source Convert Source Run Project Tests Run Apex PMD Deploy with Local Tests
- 25. Building our flow The DX setup job • Download and install Salesforce DX • Authenticate your Org • Create and Persist a Workspace
- 28. • Jobs run in independent containers. You have to persist what you want to use later… • Workspaces act as your “drive” for a build to store data. You can persist and attach them • You’ll have to export paths to your containers later • Caches can live longer than a single build • Artifacts and Test Results are can persist data from the build to access them from the CircleCI UI PERSISTENCE
- 29. Building our flow The Test Execution job • Create a new scratch org • Checkout source • Push Source to test org • Execute the Apex Unit Tests • Persist the Results • Can you add Lightning Testing Service on your own?
- 32. Building our flow The Deployment job Finally, we’ll deploy our source into a persistent environment • Sandboxes for integration tests or UAT • Productive System for final deployment • Convert Source to Metadata API format • Deploy Metadata and run specific tests or suites (not only the project’s own tests…)
- 34. Bringing it all together – the Workflow Section Use filters and requires to control ➜ order ➜ parallelism ➜ conditions of the workflow execution
- 35. DONE! • Make a change and commit to your repo… • But don’t push yet…!
- 37. Running our flow o Let’s push your commit to origin o Extra: Make any other change you like. o Review your CircleCI workflow – did it complete?
- 39. DEMO
- 40. Static code analysis as QUALITY GATE • Static code analysis checks your code/metadata against pre -defined rules • I’ll embed Apex PMD to showcase a free, community maintained product, but you can add services like Clayton.io as well • Violations appear as errors and can be used to block merges
- 41. Quality Gates: STEPS • Download PMD • Scan for Violations by using the standard ruleset
- 44. Quality Gate LET’S TRY IT OUT • Let’s violate an Apex PMD rule • add DML in a loop • Or an empty method • Or a badly named method (like Badly_namedMethod() ) • Commit & push • Check what happens to our build
- 45. 7 NEXT STEPS
- 46. NEXT STEPS • Break down monolythic metadata of your project • use 2nd generation packages to have smaller installable bundles See an excellent example here: https://github.com/trailheadapps/easy-spaces • Parallelize test jobs to save time. See a smart approach here: https://github.com/Szandor72/dreamole18-ci-in-30-minutes
- 47. Sample Project Find the repo at github.com/dstdia/CircleCI-Webinar
- 48. THANK Y U! Connect with me Twitter: @stangomat Email: [email protected]
- 49. die.interaktiven GmbH & Co. KG Am Leitz-Park 4 · D-35578 Wetzlar Phone Fax [email protected] www.die-interaktiven.de +49 6441 38457-0 +49 6441 38457-90