ryansiu1995 / gcb-visualizer Goto Github PK

Cloudbuild pipeline visualizer with graphviz

License: MIT License

Go 88.02% Makefile 0.93% Python 9.33% Dockerfile 1.73%

cloudbuild gcp gcb google-cloud-build graphviz graphviz-dot

gcb-visualizer's Introduction

Google Cloud Build Pipeline Visualizer

For the current version of Google cloud build, it supports the async process with the variable waitFor. With the growth of complexity of your pipeline, it will be hard to maintain the async flow. Unlike Jenkins and CircleCI, there is no visualizer for your pipeline. This application aims at visualize the pipeline and help the developers to debug their cloud build.

Current features

YAML format cloud build definition digestion
Temporary graph rendering
Save graph as dot, png, jpg or jpeg
JSON format support

Rule of cloud build async process

From the Google docs, there are a few rules for the async process.

If no values are provided for waitFor, the build step waits for all prior build steps in the build request to complete successfully before running.
A step is dependent on every id in its waitFor and will not launch until each dependency has completed successfully.
By declaring that a step depends only on -, the step runs immediately when the build starts.

How to install

Through go get (Recommended)

You can install the binary through the following command.
```
go get -u github.com/RyanSiu1995/gcb-visualizer
```
Install the pre-built binary

You can download the pre-built binary in release page of this repo. Because of the C binding in the Graphviz library, there is a difficulty in building binary based on different common OS and Arch. The current pre-built binaries are built under 64 bit. If you are an user with 32 bits system, please use other approach. If the pre-built binary does not work. Please report on the issue.
Use pre-built docker image

You can use docker image released to execute the gcb-visualizer without considering the OS and Arch. Please follow this instruction to setup the command alias.
```
docker pull ryansiu1995/gcb-visualizer:latest
alias gcb-visualizer="docker run -v $(pwd):/app ryansiu1995/gcb-visualizer:latest"
```
or this command in powershell
```
docker pull ryansiu1995/gcb-visualizer:latest
Set-Alias gcb-visualizer "docker run -v $(pwd):/app ryansiu1995/gcb-visualizer:latest"
```
You can put the alias to your profile in order to create a permanent alias.

How to use

You can visualize your pipeline with the following command.

gcb-visualizer visualize <your-cloudbuild-yaml-or-json-file>

If you want to output the graph into other formats, you can use the output flag as the following.

gcb-visualizer visualize --output my-pipeline.jpg <your-cloudbuild-yaml>

The current supported output formats are jpg, jpeg, dot and png.

Example Output

Given an example input of something like the Google Cloud integration test example you should get an output that looks something like this

Future features

Cloudbuild definition linting and checking
Multiple OS and Arch binary building
Brew, Apt and Chocolatey support
Quick installation script
More beautiful generated graph

Contributing

Please feel free to submit a pull request or open an issue for the application improvement. Before creating the pull request, please kindly run the follow command to test the program

make tests

License

This project is licensed under the MIT License - see the LICENSE.md file for details

gcb-visualizer's People

Contributors

Stargazers

Watchers

Forkers

jimsforks elgohr-update

gcb-visualizer's Issues

Building the multiple OS and Arch binaries

Currently, we build the binary on the fixed OS provided by GitHub Action.
The cross compiling from Golang raised the following error during compiling the graphviz C library binding.

../../../../pkg/mod/github.com/goccy/[email protected]/cdt/cdt.go:6:2: build constraints exclude all Go files in ~/Documents/golang/pkg/mod/github.com/goccy/[email protected]/internal/ccall

We need to fix this in order to build multiple OS and Arch binaries.

Set the default command as visualize

As requested by some folks, it is better if we can set the default command as alias for visualize.
i.e.

gcb-visualizer visualize cloudbuild.yaml == gcb-visualizer cloudbuild.yaml

Create a chrome extension for gcb-visualizer

Use this library, https://github.com/fabioberger/chrome to serve the gcb-visualizer as a chrome extension.

Integration with package managers

We need to integrate with different package managers in order to have a better release management.
On stage one, the list in the following is the target release platform.

brew
chocolatey
apt

Docker support for non-64-bits user

The issue for cross compiling may not be resolved soon.
We may need to create a docker image for those who are using 32bits.

Fix the hard comparison between the YAML and DOT file

Currently, the comparison between YAML and DOT files is using the string comparison.
This will be hard to maintain the test cases.
The library github.com/goccy/go-graphviz is not compatible to the EqualValues function in github.com/stretchr/testify.
We may need to extend the Graph type to do the comparison.
This function is expected to locate in pkg as a public API for others to call.

Quick installation script

We can create a quick installation script so that the user can quickly use curl to get the latest release.
It can be a shell script and a powershell script for windows user.
For the time being, we may just download the pre-built binary based on the OS.
On the future, we may need to integrate with the package managers from issue #9.

Define the linting rules
Define the linter framework
Implement the API for the linter
Integrate the API with the CLI