Skip to main content

More on Site Architecture / CI/CD / and Repos

We're starting to move from the high level overview and more into the details of our project. 

Architecture
We established that we using React as our front end technology and ColdFusion as our server side. At a more granular level, we'll be using React with Redux for our front end app and we want our server side to be not just "ajax" enabled but a true REST API. To this end, we're going to incorporate Coldbox from Ortus Solutions.

Repos
These two code bases have different needs, and possibly locations, when they are deployed. As a result, we're going to have two repositories: one for the React and another for the API. This will allow us to keep our code separated and cleaner all the way through to deployment. 

For each of these repos, we'll follow the procedure we laid out previously with the MASTER branch being used to deploy to production and a DEVELOPMENT branch being used for active work which is then fed into the Master branch via pull requests. 

Testing
Code refactors over time as do processes. Our CI/CD and testing procedures are going to evolve over time as our app gets more complete and has different needs. CF will have BDD tests run by Testbox from Ortus. Our React app needs to be developed with JS based tests from Jest, Enzyme or other library. However, truth be told, I haven't gotten my head around any of these libraries yet so we're going to use a testing method I already use for front end testing which is Selenium. The library, CFSelenium, has provided a CF wrapper for Selenium and we'll use some work I've already built out to add onto that. By leveraging those aspects, we can use TestBox as the tool to drive both our CF testing and our React testing. This won't be true React unit testing but we will be able to do more than just test the DOM.

CI/CD
CF: One hang up for the CI/CD process is the need to learn Docker. I haven't been able to set aside the time to learn at the same time that I have a project to actually put it to use to get the practical aspects of it down. As a result, we are going to do the first iteration of our CI/CD using simple web-hooks to trigger our deployment and tests for our ColdFusion Rest API. 

React: Originally I was thinking that we would set up our CI/CD for React to deploy to a S3 bucket and attach a Cloudfront to it. That way we can server the static files easily from something "serverless" (i.e. something we don't need to mess with or maintain) and get those requests and cycles off of a server which we do need to maintain. However, I recently ran across AWS Amplify which has a great deal of promise for a low maintenance CI/CD for React. More on that later.   

Labels:

Comments

Post a Comment

Popular posts from this blog

Creating Stories and Tasks in Jira: Personas and our Software Development Team

Part of the CI/CD Development Series The next step is developing who is on our hypothetical development team. Given that it has a React front end and ColdFusion as the Server Side language, I came up with the following personas, all of which have their own needs and considerations for our development environment. I've listed all the jobs that need doing, not the people involved since, even on a small team or a team of one, these "hats" are all worn by someone, even if it's the same person. Personas for our Project Dev Ops Coordinator - The person responsible for smooth and accurate deployments CF Developer - The person responsible for the API and fulfillment code development and maintenance. React Developer - The person responsible for the front end development Database Coordinator - The person responsible for the schema, data, up time and, presumably the testing databases used by the developers. Lead Developer - The person responsible for coordinat
6 comments
Read more

The Three Deployment Environments: Production, Testing, Development

Part of the CI/CD Development Series A UML Deployment Diagram is a static picture that shows the different "nodes" that work together to create an environment. Typically these nodes consist of hardware, software or other key points. It's a high level overview, just enough detail to get the idea across of the layout without getting too lost in the details. These are the three deployment diagrams for our project. Production The production deployment is more elaborate than the other two below. Our project has a React front end which means that in addition to images and CSS files, it will also have a largish number of Javascript files. All of these are static and do not need any server side processing. As a result, we don't want them on our ColdFusion server taking up space, memory, bandwidth and other resources when we can use those resources for more efficient processing of ColdFusion files. This allows our server to handle more CF requests since they are not busy
1 comment
Read more

As the Dev Ops Coordinator, I need to set up our git repo into several branches with the appropriate permissions for each one

Part of the CI/CD Development Series The core of every CI/CD process is the code repository whether it be Git, Mercurial, SVN or whatever. The general idea is that it allows multiple developers (or whomever) to access your code in the appropriate way in the appropriate level. This can either be the ability for anyone to pull an open source project but not write to the repo directly or full access to a developer on your team to create branches, push to master or anything that needs doing. For our project, we're using git although the hosting provider was up for discussion between Github, Bitbucket by Atlassian or CodeCommit on AWS. We decided to go with AWS for two reasons. 1. We are going use other tools in AWS as part of the build so we decided to keep it all together. 2. We needed to solidify the ins and outs of using IAM for the process. Basic Steps Create the Repo Create the branches we need Use IAM to apply the appropriate permissions to each branch and to set up
1 comment
Read more