Environments: Production Staging Demo
This dashboard is a web application to manage cloud.gov organizations, spaces, services, and apps.
Learn more about cloud.gov.
Go
(version 1.8)
Node
(version 6.x.x)React
(version ^15.0.0)Babel
(version ^6.x.x)Karma
(version ^1.4.x)Webpack
(version ^1.x.x)
The Go backend isn't strictly required for all development. Consider running locally with node if you will not be doing primary feature work where you need access to the actual Cloud Foundry API.
If you are unfamiliar with Go
project directory structure, you want the code in this repository to be in something like <your-code-directory>/src/github.com/18f/cg-dashboard
. You can use that exact pattern by cloning the repository with:
git clone [email protected]:18F/cg-dashboard.git src/github.com/18F/cg-dashboard
If you are testing locally, export these variables. There is a sample file of environment variables called env.sample
. Feel free to copy it and use the proper data. If you've never used environment variables before, you can run the following:
mkdir ~/.env && cp ./env.sample ~/.env/cg-dashboard
Then edit the file ~/.env/cg-dashboard
and provide the proper values. When you want to set all the environment variables, just run source ~/.env/cg-dashboard
. You'll have to do this every time you open a new shell. If you work at 18F, ask a team member to send you the secret credentials.
GOPATH
: The absolute path to your code directory, one level up from the root of this project. If you followed the cloning instructions above, this path should correspond to the value you used for<your-code-directory>
.CONSOLE_CLIENT_ID
: Registered client id with UAA.CONSOLE_CLIENT_SECRET
: The client secret.CONSOLE_HOSTNAME
: The URL of the service itself.CONSOLE_LOGIN_URL
: The base URL of the auth service. i.e.https://login.domain.com
CONSOLE_UAA_URL
: The URL of the UAA service. i.e.https://uaa.domain.com
CONSOLE_API_URL
: The URL of the API service. i.e.http://api.domain.com
CONSOLE_LOG_URL
: The URL of the loggregator service. i.e.http://loggregator.domain.com
PPROF_ENABLED
: If set totrue
or1
, will turn on/debug/pprof
endpoints as seen here
You need to have Docker installed and active within your environment as the unit tests use Docker for short term real instances.
To run the go tests:
$ ./codecheck.sh
fmt
can be used to fix any linting errors:
$ go fmt ./controllers
Front end build commands should be run in the same directory as the package.json
file. If you've used the cloning command from this README it should be something like /path/to/cg-dashboard-ws/src/github.com/18F/cg-dashboard
. Node version 6 and above should always be used.
Install front end dependencies (may require special steps for node-gyp):
npm install
Build the code:
npm run build
or to continually watch and build with changes:
npm run watch
To run the tests:
npm run test
or to continually watch for changes and run test suite:
npm run watch-test
To lint the code (also run as part of tests):
npm run lint
In order to get correct synatax highlighting with vim, install the following npm modules globally:
npm install -g eslint
npm install -g babel-eslint
npm install -g eslint-plugin-react
- Make sure all of your environment variables are set and you are using the Go version as mentioned above.
- Install glide
- Run
glide install
to get all third party code go run server.go
- Navigate browser to
http://localhost:9999
This is an easy way to test out front end changes without needing to set up environment variables or Go
. We will use a small server with fake data (used for automated testing) to get going quickly. If you want to see live data, you'll need to follow the instructions above.
The command npm run testing-server
will run the server. We will still be using npm run watch
to build the front end application when the file changes.
npm install
to get the Javascript dependenciesnpm run testing-server & npm run watch
to start the server and build process
Now when you're done, you'll want to stop the testing-server
that is running in the background. You can find it by running jobs
, and the line that looks like this:
[N] + running npm run testing-server
To kill that process, run kill %N
where "N" is the number from the line.
go test $(glide nv)
Test can then be run with the command:
npm run test
The cloud.gov dashboard is continuously deployed by CircleCI. To deploy manually:
In each space that you plan on deploying, you need to create a user-provided-service
.
Run:
# For applications without New Relic monitoring
cf cups dashboard-ups -p '{"CONSOLE_CLIENT_ID":"your-client-id","CONSOLE_CLIENT_SECRET":"your-client-secret", "SESSION_KEY": "a-really-long-secure-value", "SMTP_HOST": "smtp.host.com", "SMTP_PORT": "25", "SMTP_USER": "username", "SMTP_PASS": "password", "SMTP_FROM": "[email protected]"}'
# For applications with New Relic monitoring
cf cups dashboard-ups -p '{"CONSOLE_CLIENT_ID":"your-client-id","CONSOLE_CLIENT_SECRET":"your-client-secret","CONSOLE_NEW_RELIC_LICENSE":"your-new-relic-license", "SESSION_KEY": "a-really-long-secure-value", "SMTP_HOST": "smtp.host.com", "SMTP_PORT": "25", "SMTP_USER": "username", "SMTP_PASS": "password", "SMTP_FROM": "[email protected]"}'
Create a redis service instance:
cf create-service redis28 standard dashboard-redis
- Make sure UAAC is installed.
- Target your UAA server.
uaac target <uaa.your-domain.com>
- Login with your current UAA account.
uaac token client get <your admin account> -s <your uaa admin password>
- Create client account:
uaac client add <your-client-id> \
--authorities scim.invite \
--authorized_grant_types authorization_code,client_credentials,refresh_token \
--scope cloud_controller.admin,cloud_controller.read,cloud_controller.write,openid,scim.read \
--autoapprove true \
-s <your-client-secret>
- Unable to create an account still? Troubleshoot here
This project uses CircleCI.
- You will need to set up the credentials to deploy to the
dashboard-prod
anddashboard-stage
spaces.- In both spaces run:
cf create-service cloud-gov-service-account space-deployer dashboard-deployer
. - You will get the link for that space's credentials by running
cf service dashboard-deployer
. - You will need to set these secret variables in the CircleCI UI.
CF_USERNAME_PROD_SPACE
- The username for thedashboard-prod
deployerCF_PASSWORD_PROD_SPACE
- The password for thedashboard-prod
deployerCF_USERNAME_STAGE_SPACE
- The username for thedashboard-stage
deployerCF_PASSWORD_STAGE_SPACE
- The password for thedashboard-stage
deployer
- In both spaces run:
- If you fork this project for your own use, you will need to use the CircleCI CLI UI to set the variables. (If you're forking just to make a pull request, there's no need to do this.)
Some features can be enabled by supplying the right environment configuration.
If you have New Relic Browser, you can set your New Relic ID and Browser license key. These are public and can be set in your manifest file. Note that your Browser license key is different than your New Relic License Key (which should be treated as confidential).
# manifest.yml
env:
NEW_RELIC_ID: 12345
NEW_RELIC_BROWSER_LICENSE_KEY: abcdef
If you have a GA site configured, specify your tracking ID as GA_TRACKING_ID
in your environment.
# manifest.yml
env:
GA_TRACKING_ID: UA-123456-11
Functional tests are our high-level automated UI tests that are run from the browser. They can be slow to run, but often catch issues that only appear when functional components appear together, like when running in a real web browser.
The tests are based on Webdriver and use the Selenium Standalone server to drive the browsers.
- Java 8
You'll only have to do this once. This downloads the browser-specific drivers that we have configured.
$ npm run test-selenium-install
$ npm run test-functional