Merge pull request #3 from im2nguyen/docker-v1.0.1-ui-updates

Add Docker quickstart, update UI, fix TF v1.0.1 issue
im2nguyen · Jul 2, 2021 · a173813 · a173813
2 parents 8b8fb3a + 556040f
commit a173813
Show file tree

Hide file tree

Showing 22 changed files with 155 additions and 38 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,14 @@
+ARG TF_VERSION=light
+
+FROM hashicorp/terraform:$TF_VERSION
+
+RUN cp /bin/terraform /usr/local/bin/terraform
+
+COPY ./rover /bin/rover
+RUN chmod +x /bin/rover
+
+WORKDIR /src
+
+ENTRYPOINT [ "/bin/rover" ]
+
+# CMD ["rover"]
diff --git a/README.md b/README.md
@@ -12,6 +12,39 @@ Feedback (via issues) and pull requests are appreciated!
 
 ![Rover Screenshot](docs/rover-cropped-screenshot.png)
 
+## Quickstart
+
+The fastest way to get up and running with Rover is through Docker.
+
+Run the following command in any Terraform workspace to generate a visualization. This command copies all the files in your current directory to the Rover container and exposes port `:9000`.
+
+```
+$ docker run --rm -it -p 9000:9000 -v $(pwd):/src im2nguyen/rover
+2021/07/02 06:46:23 Starting Rover...
+2021/07/02 06:46:23 Initializing Terraform...
+2021/07/02 06:46:24 Generating plan...
+2021/07/02 06:46:25 Parsing configuration...
+2021/07/02 06:46:25 Generating resource overview...
+2021/07/02 06:46:25 Generating resource map...
+2021/07/02 06:46:25 Generating resource graph...
+2021/07/02 06:46:25 Done generating assets.
+2021/07/02 06:46:25 Rover is running on localhost:9000
+```
+
+Once Rover runs on `localhost:9000`, navigate to it to find the visualization!
+
+Use `--env` or `--env-file` to set environment variables in the Docker container. For example, you can save your AWS credentials to an `.env` file.
+
+```
+$ printenv | grep "AWS" > .env
+```
+
+Then, add it as environment variables to your Docker container with `--env-file`.
+
+```
+$ docker run --rm -it -p 9000:9000 -v $(pwd):/src --env-file ./.env im2nguyen/rover
+```
+
 ## Installation
 
 You can download Rover binary specific to your system by visiting the [Releases page](https://github.com/im2nguyen/rover/releases). Download the binary, unzip, then move `rover` into your `PATH`.
@@ -57,6 +90,21 @@ Compile and install the binary. Alternatively, you can use `go build` and move t
 $ go install
 ```
 
+### Build Docker image
+
+First, compile the binary for `linux/amd64`.
+
+```
+$ env GOOS=linux GOARCH=amd64 go build .
+```
+
+Then, build the Docker image.
+
+```
+$ docker build . -t im2nguyen/rover
+```
+
+
 ## Basic usage
 
 This repository contains two example Terraform configurations in `example`.
@@ -88,4 +136,4 @@ You can specify the working directory (where your configuration is living) and t
 $ rover -workingDir "example/eks-cluster" -tfPath "/Users/dos/terraform"
 ```
 
-Once Rover runs on `localhost:9000`, navigate to it to find the visualization!
+Once Rover runs on `localhost:9000`, navigate to it to find the visualization!
diff --git a/example/.DS_Store b/example/.DS_Store
diff --git a/example/random-test/.terraform.lock.hcl b/example/random-test/.terraform.lock.hcl
diff --git a/graph.go b/graph.go
@@ -380,6 +380,14 @@ func GenerateEdges(plan *tfjson.Plan) []Edge {
 						targetType = DATA_COLOR
 					}
 
+					// For Terraform 1.0, resource references point to specific resource attributes
+					// Skip if the target is a resource and reference points to an attribute
+					if targetType == RESOURCE_COLOR && len(strings.Split(dependsOnR, ".")) != 2 {
+						continue
+					} else if targetType == DATA_COLOR && len(strings.Split(dependsOnR, ".")) != 3 {
+						continue
+					}
+
 					id := fmt.Sprintf("%s->%s", resource.Address, dependsOnR)
 					emo = append(emo, id)
 					edgeMap[id] = Edge{
@@ -419,6 +427,14 @@ func GenerateEdges(plan *tfjson.Plan) []Edge {
 						targetType = DATA_COLOR
 					}
 
+					// For Terraform 1.0, resource references point to specific resource attributes
+					// Skip if the target is a resource and reference points to an attribute
+					if targetType == RESOURCE_COLOR && len(strings.Split(dependsOnR, ".")) != 2 {
+						continue
+					} else if targetType == DATA_COLOR && len(strings.Split(dependsOnR, ".")) != 3 {
+						continue
+					}
+
 					id := fmt.Sprintf("%s->%s", fmt.Sprintf("module.%s", mid), dependsOnR)
 					emo = append(emo, id)
 					edgeMap[id] = Edge{

diff --git a/ui/dist/css/app.bf24ba71.css → ui/dist/css/app.52fc4fd2.css b/ui/dist/css/app.bf24ba71.css → ui/dist/css/app.52fc4fd2.css
diff --git a/ui/dist/favicon.ico b/ui/dist/favicon.ico
diff --git a/ui/dist/index.html b/ui/dist/index.html
@@ -1 +1 @@
-<!DOCTYPE html><html lang=""><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="/favicon.ico"><title>ui</title><link rel="stylesheet" href="/chota.min.css"><link rel="stylesheet" href="/style.css"><link href="/css/app.bf24ba71.css" rel="preload" as="style"><link href="/js/app.d4ce5b47.js" rel="preload" as="script"><link href="/js/chunk-vendors.0b54d9ce.js" rel="preload" as="script"><link href="/css/app.bf24ba71.css" rel="stylesheet"></head><body><noscript><strong>We're sorry but ui doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id="app"></div><script src="/js/chunk-vendors.0b54d9ce.js"></script><script src="/js/app.d4ce5b47.js"></script></body></html>
+<!DOCTYPE html><html lang=""><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="/favicon.ico"><title>ui</title><link rel="stylesheet" href="/chota.min.css"><link rel="stylesheet" href="/style.css"><link href="/css/app.52fc4fd2.css" rel="preload" as="style"><link href="/js/app.53202c6f.js" rel="preload" as="script"><link href="/js/chunk-vendors.bd6ebaf4.js" rel="preload" as="script"><link href="/css/app.52fc4fd2.css" rel="stylesheet"></head><body><noscript><strong>We're sorry but ui doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id="app"></div><script src="/js/chunk-vendors.bd6ebaf4.js"></script><script src="/js/app.53202c6f.js"></script></body></html>
diff --git a/ui/dist/js/app.53202c6f.js b/ui/dist/js/app.53202c6f.js
diff --git a/ui/dist/js/app.53202c6f.js.map b/ui/dist/js/app.53202c6f.js.map
diff --git a/ui/dist/js/app.d4ce5b47.js b/ui/dist/js/app.d4ce5b47.js
diff --git a/ui/dist/js/app.d4ce5b47.js.map b/ui/dist/js/app.d4ce5b47.js.map
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<!DOCTYPE html><html lang=""><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="/favicon.ico"><title>ui</title><link rel="stylesheet" href="/chota.min.css"><link rel="stylesheet" href="/style.css"><link href="/css/app.bf24ba71.css" rel="preload" as="style"><link href="/js/app.d4ce5b47.js" rel="preload" as="script"><link href="/js/chunk-vendors.0b54d9ce.js" rel="preload" as="script"><link href="/css/app.bf24ba71.css" rel="stylesheet"></head><body><noscript><strong>We're sorry but ui doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id="app"></div><script src="/js/chunk-vendors.0b54d9ce.js"></script><script src="/js/app.d4ce5b47.js"></script></body></html>
		<!DOCTYPE html><html lang=""><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="/favicon.ico"><title>ui</title><link rel="stylesheet" href="/chota.min.css"><link rel="stylesheet" href="/style.css"><link href="/css/app.52fc4fd2.css" rel="preload" as="style"><link href="/js/app.53202c6f.js" rel="preload" as="script"><link href="/js/chunk-vendors.bd6ebaf4.js" rel="preload" as="script"><link href="/css/app.52fc4fd2.css" rel="stylesheet"></head><body><noscript><strong>We're sorry but ui doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id="app"></div><script src="/js/chunk-vendors.bd6ebaf4.js"></script><script src="/js/app.53202c6f.js"></script></body></html>