Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/devkeydet/dyn365-ce-devops

DevOps for Dynamics 365 Customer Engagement (CE) is becoming a popular topic. The goal of this project is to help Dynamics 365 CE solution builders understand and accelerate their implementation of DevOps practices with Dynamics CE and VSTS.
https://github.com/devkeydet/dyn365-ce-devops

build-automation continuous-delivery continuous-deployment continuous-integration crm devops dynamics dynamics-365 dynamics-crm msdyn365 release-automation visual-studio-team-services vsts

Last synced: 18 days ago
JSON representation

Host: GitHub
URL: https://github.com/devkeydet/dyn365-ce-devops
Owner: devkeydet
License: mit
Created: 2017-09-29T17:54:00.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2018-10-22T15:28:28.000Z (over 6 years ago)
Last Synced: 2024-11-14T20:36:51.051Z (3 months ago)
Topics: build-automation, continuous-delivery, continuous-deployment, continuous-integration, crm, devops, dynamics, dynamics-365, dynamics-crm, msdyn365, release-automation, visual-studio-team-services, vsts
Homepage:
Size: 53.7 KB
Stars: 90
Watchers: 35
Forks: 28
Open Issues: 13
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Introduction
Please watch the following video to get a high level overview of this project:

[![Video Introduction](https://img.youtube.com/vi/AorM792M8nY/0.jpg)](https://www.youtube.com/watch?v=AorM792M8nY)

The project provides reference examples of using [Visual Studio Team Service (VSTS)](https://www.visualstudio.com/team-services/) to build and deploy Dynamics 365 based applications. The reference examples are based on various use cases, including:

* [Primary Release - Dynamics Only.json](https://github.com/devkeydet/dyn365-ce-devops/blob/master/Primary%20Release%20-%20Dynamics%20Only.json) - Deploying a Dynamics 365 solution package and initial data from source control.
* [Primary Release - Dynamics + Azure.json](https://github.com/devkeydet/dyn365-ce-devops/blob/master/Primary%20Release%20-%20Dynamics%20%2B%20Azure.json) - Builds on [Primary Release - Dynamics Only.json](https://github.com/devkeydet/dyn365-ce-devops/blob/master/Primary%20Release%20-%20Dynamics%20Only.json) and adds deployment of Azure components to the release to demonstrate deploying a release across both.

The intent of this project is to evolve (over time) to implement additional reference examples based on common and/or requested use cases. Lessons learned from this project have resulted in contributions back to https://github.com/waelHamze/xrm-ci-framework/ and https://github.com/scottdurow/SparkleXrm/wiki/spkl. Please feel free to suggest new scenarios / starter templates or other ideas via the [issues](https://github.com/devkeydet/dyn365-ce-devops/issues) section.

These release templates point to a sample application that spans Dynamics 365 & Azure. The source code that will be built and deployed by VSTS is available at:
https://github.com/devkeydet/CrmAsyncRequestResponseSampleV2

The source code in the repository above shows how to source control *both* code and configurations associated with a Dynamics 365 demo/poc/sample.

The reference build definitions show two different build scenarios:

* [Primary Build.json](https://github.com/devkeydet/dyn365-ce-devops/blob/master/Primary%20Build.json) - shows how to use VSTS to:
* Build assets from a remote GitHub repository
* This, of course, could be done from a VSTS repository as well depending on whether the source code should be public or private
* Build all the assets from source control into their deployable form
* Reports unit test pass/fail for both .net and javascript code as part of build reporting
* Reports code coverage of unit tests
* Minifies JavaScript using [Gulp](https://gulpjs.com/)
* Solution package zip files
* Packages Dynamics 365 configuration xml files using [Solution Packager](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/use-source-control-solution-files)
* Starter data import zip files
* Zips up xml files produced by the [Configuration Migration](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/admin/manage-configuration-data) tool to setup sample data
* .NET dlls for both Dynamics 365 and an [Azure Function App](https://azure.microsoft.com/en-us/services/functions/)
* etc.
* [Patch Build.json](https://github.com/devkeydet/dyn365-ce-devops/blob/master/Patch%20Build.json) - shows how to use VSTS to:
* Build a simple [patch](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/create-patches-simplify-solution-updates) from source control

The reference release definitions show how to deploy assets from the build to the target environment(s). Each does the following:
* Primary Release - Dynamics Only.json
* Resets a Dynamics 365 instance by using the [Online Management API for Dynamics 365 Customer Engagement](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/online-management-api)
* Deploys the Dynamics 365 package and sample/intiial data using [Package Deployer](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/admin/deploy-packages-using-package-deployer-windows-powershell)
* Demonstrates how to activate plugins *after* the sample/initial data is imported
* Updates plugin [Secure Configuration](https://us.hitachi-solutions.com/blog/use-secure-vs-unsecure-configuration-plugins/) since it doesn't get stored in the solution package and can vary by environment
* Backs up the Dynamics 365 instance using the [Online Management API for Dynamics 365 Customer Engagement](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/online-management-api)
* Primary Release - Dynamics + Azure.json
* Registers and Azure AD application so the code hosted in Azure has permissions to make web api calls to Dynamics 365
* Resets a Dynamics 365 instance by using the [Online Management API for Dynamics 365 Customer Engagement](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/online-management-api)
* Deploys an [Azure Resource Manager](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-overview) [template](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-overview#template-deployment) to provision necessary Azure resources
* Gets configuration data from the Azure deployment for use in latter parts of the deployment process
* Deploys Azure Functions dlls from the build
* Applies configuration settings to the Azure environment
* Deploys the Dynamics 365 package and sample data using [Package Deployer](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/admin/deploy-packages-using-package-deployer-windows-powershell)
* Updates plugin [Secure Configuration](https://us.hitachi-solutions.com/blog/use-secure-vs-unsecure-configuration-plugins/) since it doesn't get stored in the solution package and can vary by environment
* Backs up the Dynamics 365 instance using the [Online Management API for Dynamics 365 Customer Engagement](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/online-management-api)
* Patch Release - Dynamics Only.json
* Restore a Dynamics 365 instances to test applying the patch to, using the [Online Management API for Dynamics 365 Customer Engagement](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/online-management-api)
* Import the patch solution
* Publish the customizations
* Disable Admin Mode using the [Online Management API for Dynamics 365 Customer Engagement](https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/online-management-api)

# UI Automation Testing
The source code of the sample application has a project called [UIAutomationTests](https://github.com/devkeydet/CrmAsyncRequestResponseSampleV2/tree/master/UIAutomationTests), which uses https://github.com/microsoft/easyrepro to demonstrate how perform automated UI testing for Dynamics 365. However, the tests are not yet incorporated into a release as a predeployment quality gate. There is a known issue when using https://github.com/microsoft/easyrepro with the phantomjs driver for headless test execution. Therefore, we cannot run the UI automation tests using the hosted VSTS agent. The hosted agent doesn't have browsers installed. The workaround today is to deploy your own agent. Doing so would allow you to install a browser and use one of the selenium browser drivers. See https://docs.microsoft.com/en-us/vsts/build-release/test/continuous-test-selenium for more details.

# Getting Started
## Prereqs
1. [Primary Build.json](https://github.com/devkeydet/dyn365-ce-devops/blob/master/Primary%20Build.json) requires several VSTS extensions to fully function. Before beginning please install the following extensions.
- [Dynamics 365 Build Tools](https://marketplace.visualstudio.com/items?itemName=WaelHamze.xrm-ci-framework-build-tasks)
- [RegEx Match & Replace](https://marketplace.visualstudio.com/items?itemName=kasunkodagoda.regex-match-replace)
- [File Operations](https://marketplace.visualstudio.com/items?itemName=KirKone.fileoperations)
## Reference Examples Step by Step
Please watch the following videos to help you understand how to get started:

*Part I* - This video walks through [Primary Build.json](https://github.com/devkeydet/dyn365-ce-devops/blob/master/Primary%20Build.json) and [Primary Release - Dynamics Only.json](https://github.com/devkeydet/dyn365-ce-devops/blob/master/Primary%20Release%20-%20Dynamics%20Only.json), with a goal of helping you understand how they work and how to import them into your own VSTS project.

[![Video walkthrough part one](https://img.youtube.com/vi/O_q3cSWAUVI/0.jpg)](https://www.youtube.com/watch?v=O_q3cSWAUVI)

*Part II* - This video assumes you watched *Part I*. It builds on *Part I*, with a goal of helping you understand how to import and execute [Primary Release - Dynamics + Azure.json](https://github.com/devkeydet/dyn365-ce-devops/blob/master/Primary%20Release%20-%20Dynamics%20%2B%20Azure.json), which includes a more elaborate example, including provisioning, deploying and configuring Azure services and code that work as part of the overall application.

[![Video walkthrough part two](https://img.youtube.com/vi/hlAEMr4xlCY/0.jpg)](https://www.youtube.com/watch?v=hlAEMr4xlCY)

## From Scratch
The previous videos walk you through the reference examples. If you would like a "from scratch" walkthrough of how to start with empty Dynamics 365 & Visual Studio solutions and get to a basic DevOps starting point, please review the following videos:

*Zero to full source control of a model-driven PowerApp using spkl*
[![Video walkthrough part two](https://img.youtube.com/vi/nutWII2ntVQ/0.jpg)](https://www.youtube.com/watch?v=nutWII2ntVQ)

*Build and deployment automation of a model-driven PowerApp using VSTS*
[![Video walkthrough part two](https://img.youtube.com/vi/R18HOh2j40k/0.jpg)](https://www.youtube.com/watch?v=R18HOh2j40k)

NOTE: As of the [spring 2018 release](https://powerapps.microsoft.com/en-us/blog/powerapps-spring-announce/), the core platform in Dynamics 365 (often referred to as XRM) is now available as part of PowerApps. Specifically, [model-driven](https://docs.microsoft.com/en-us/powerapps/maker/model-driven-apps/model-driven-app-overview) [PowerApps](https://docs.microsoft.com/en-us/powerapps/maker/index) which require the [Common Data Service](https://docs.microsoft.com/en-us/powerapps/maker/common-data-service/data-platform-intro). Said another way, because of this evolution and new branding, the Dynamics 365 CE apps are now built on PowerApps and the Common Data Service. As we evolve this GitHub project, we will work on updating the terminology used in order to be consistent.