Merge pull request #7 from bigcommerce/cci

CodeClimate + OSS prep

Author: splittingred

.circleci/config.yml

@@ -1,36 +1,59 @@
 version: 2.1
 
+#################################################################################
+# Orbs
+#################################################################################
 orbs:
   ci: bigcommerce/internal@volatile
+  code-climate: bigcommerce/internal-codeclimate@volatile
 
+#################################################################################
+# Executors
+#################################################################################
 executors:
   go:
     docker:
       - image: cimg/go:1.17
         environment:
           DOCKER_API_VERSION: 1.39
 
+#################################################################################
+# Jobs
+#################################################################################
+job_defaults: &job_defaults
+  executor: go
+  working_directory: /home/circleci/go/src/github.com/bigcommerce/bonvoy
+
 jobs:
   test-unit:
-    executor: go
+    <<: *job_defaults
     steps:
       - ci/pre-setup
+      - code-climate/setup
       - run: make deps test-unit
+      - code-climate/after-build:
+          coverage-format: 'gocov'
   test:
-    executor: go
+    <<: *job_defaults
     steps:
       - ci/pre-setup
       - run: make deps test
   build:
-    executor: go
+    <<: *job_defaults
     steps:
       - ci/pre-setup
       - run: make deps build
 
+#################################################################################
+# Workflows
+#################################################################################
 workflows:
   version: 2
   full:
     jobs:
       - test-unit
       - test
-      - build
+      - build:
+          requires:
+            - test
+            - test-unit

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,4 @@
+## What? Why?
+
+
+## How was it tested?

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at engineering@bigcommerce.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing to bonvoy
+
+## Pull Requests
+
+First ensure that your feature isn't already being developed or considered (see open PRs and issues).
+If it is, please consider contributing to those initiatives.
+
+All PRs require test coverage to be accepted when applicable.
+
+## Issues / Bugs
+
+* Please include a clear, specific title and replicable description.
+
+* Please include your environment, OS, and any exceptions/backtraces that occur. The more
+  information that is given, the more likely we can debug and fix the issue.
+
+**If you find a security bug, please do not post as an issue. Send directly to security@bigcommerce.com
+instead.**
+
+## Other Ways to Contribute
+
+* Consider contributing to bonvoy documentation on the wiki, reporting bugs, contributing to test coverage,
+  or helping spread the word about bonvoy.
+
+* Contribute directly to Consul or Nomad! This helps bonvoy and all other initiatives.
+
+Thank you again for your interest in contributing to bonvoy!

LICENSE.md

@@ -0,0 +1,15 @@
+
+Copyright (c) 2021-present, BigCommerce Pty. Ltd. All rights reserved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -20,7 +20,7 @@ test:
 	@gotest -v $$(go list ./... | grep -v vendor/) -tags=integration
 
 test-unit:
-	@gotest $$(go list ./... | grep -v vendor/)
+	@gotest -v -coverprofile=c.out $$(go list ./... | grep -v vendor/)
 
 build-linux:
 	@CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -v -o ${OBJECT}-linux-amd64

README.md

@@ -1,11 +1,11 @@
 # Bonvoy
 
-[![CircleCI](https://circleci.com/gh/bigcommerce/bonvoy/tree/main.svg?style=svg&circle-token=df991e7eb7eb4c38c2ece44f81cc259d6d9a8929)](https://circleci.com/gh/bigcommerce/bonvoy/tree/main)
+[![CircleCI](https://circleci.com/gh/bigcommerce/bonvoy/tree/main.svg?style=svg&circle-token=df991e7eb7eb4c38c2ece44f81cc259d6d9a8929)](https://circleci.com/gh/bigcommerce/bonvoy/tree/main) [![Maintainability](https://api.codeclimate.com/v1/badges/63e2c2eb1a4e00d269e2/maintainability)](https://codeclimate.com/repos/61f18cc93e634f01a300d78c/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/63e2c2eb1a4e00d269e2/test_coverage)](https://codeclimate.com/repos/61f18cc93e634f01a300d78c/test_coverage)
 
 A simple go CLI tool to perform various tasks against Envoy sidecars in a Consul
 Connect and Nomad environment.
 
-Supports Consul 1.10+, Nomad 1.1.3+, and Envoy 1.18+. 
+Supports Consul 1.10+, Nomad 1.1.3+, and Envoy 1.18+. Requires DOCKER_API_VERSION 1.39.
 
 ## Usage
 
@@ -18,55 +18,178 @@ All commands have the ability to output in JSON format with: `-o json`
 
 List all listeners:
 ```bash
-bonvoy listeners list auth-grpc
+$ bonvoy listeners list products-grpc
+
+Listeners for products-grpc Envoy (PID 14013)
+--------------------------------------------------------------------------
+              NAME                 |    ADDRESS
+-----------------------------------+-----------------
+  envoy_metrics_listener           | 0.0.0.0:1239
+  public_listener:0.0.0.0:22904    | 0.0.0.0:22904
+  product-variants:127.0.0.1:8003  | 127.0.0.1:8003
+  product-options:127.0.0.1:8004   | 127.0.0.1:8004
 ```
 
 ### Clusters
 
 List all clusters for a sidecar:
 ```bash
-bonvoy clusters list auth-grpc
+$ bonvoy clusters list products-grpc
+
+products-grpc.default.int-us-east1.internal.asdf1234.consul
+------------------------------------------------------------------------------------------------------------
+  Outlier: Success Rate          | -1   | Outlier: Success Rate Ejection | -1
+                                 |      | Threshold                      |
+  Outlier: Local Origin -        | -1   | Outlier: Local Origin          | -1
+  Success Rate                   |      | - Success Rate Ejection        |
+                                 |      | Threshold                      |
+  Default Priority - Max         | 2048 | Default Priority - Max Retries | 3
+  Connections                    |      |                                |
+  Default Priority - Max Pending | 1024 | Default Priority - Max         | 1024
+  Requests                       |      | Requests                       |
+  High Priority - Max            | 1024 | High Priority - Max Retries    | 3
+  Connections                    |      |                                |
+  High Priority - Max Pending    | 1024 | High Priority - Max Requests   | 1024
+  Requests                       |      |                                |
+
+---------------------
+- Cluster Instances -
+---------------------
+         HOST   | CX ACTIVE | CX FAILED | CX TOTAL | REQ ACTIVE | REQ TIMEOUT | REQ SUCCESS | REQ ERROR | REQ TOTAL | SUCCESS RATE | LOCAL SUCCESS RATE | HEALTH FLAGS | REGION | ZONE | SUBZONE | CANARY
+----------------+-----------+-----------+----------+------------+-------------+-------------+-----------+-----------+--------------+--------------------+--------------+--------+------+---------+---------
+  1.2.3.4:23837 |         1 |         0 |        1 |          0 |           0 |    23436077 |         0 |  23436077 |         -1.0 |               -1.0 |      healthy |        |      |         |  false
+  1.2.3.5:23910 |         1 |         0 |        1 |          0 |           0 |    23613685 |         0 |  23613685 |         -1.0 |               -1.0 |      healthy |        |      |         |  false
+  1.2.3.6:23011 |         1 |         0 |        1 |          0 |           0 |    54314043 |         0 |  54314043 |         -1.0 |               -1.0 |      healthy |        |      |         |  false
 ```
 
 ### Certificates
 
 List all certificates:
+
 ```bash
-bonvoy certificates list auth-grpc
+$ bonvoy certificates list products-grpc
+
+----------------------------------------------------------------------------
+products-grpc Envoy (PID 14013)
+----------------------------------------------------------------------------
+Certificate Chains:
+  SAN                                                                   | SERIAL # |   PATH   |      VALID FROM      |   EXPIRATION TIME    | DAYS UNTIL EXPIRATION
+------------------------------------------------------------------------+----------+----------+----------------------+----------------------+------------------------
+  spiffe://asdf1234.consul/ns/default/dc/int-us-east1/svc/products-grpc | 17d220e0 | <inline> | 2022-01-24T22:56:46Z | 2022-01-27T22:56:46Z | 1
+  spiffe://asdf1234.consul/ns/default/dc/int-us-east1/svc/products-grpc | 17d220e0 | <inline> | 2022-01-24T22:56:46Z | 2022-01-27T22:56:46Z | 1
+  spiffe://asdf1234.consul/ns/default/dc/int-us-east1/svc/products-grpc | 17d220e0 | <inline> | 2022-01-24T22:56:46Z | 2022-01-27T22:56:46Z | 1
+
+CA Certificates:
+  SAN                      | SERIAL # |   PATH   |      VALID FROM      |   EXPIRATION TIME    | DAYS UNTIL EXPIRATION
+---------------------------+----------+----------+----------------------+----------------------+------------------------
+  spiffe://asdf1234.consul | 17ce3503 | <inline> | 2020-07-20T16:05:55Z | 2030-07-20T16:05:55Z | 3096
+  spiffe://asdf1234.consul | 17ce3503 | <inline> | 2020-07-20T16:05:55Z | 2030-07-20T16:05:55Z | 3096
+  spiffe://asdf1234.consul | 17ce3503 | <inline> | 2020-07-20T16:05:55Z | 2030-07-20T16:05:55Z | 3096
+
 ```
 
 List all expired certificates as compared to the Consul Agent:
 ```bash
-bonvoy certificates expired auth-grpc
+$ bonvoy certificates expired products-grpc
+
+  SERVICE | PID | ENVOY EXPIRY | DAYS LEFT | CONSUL LEAF EXPIRY | RESTARTED
+----------+-----+--------------+-----------+--------------------+------------
 ```
 
 Or show all certs expired on a host:
 ```bash
-bonvoy certificates expired all
+$ bonvoy certificates expired all
+
+  SERVICE | PID | ENVOY EXPIRY | DAYS LEFT | CONSUL LEAF EXPIRY | RESTARTED
+----------+-----+--------------+-----------+--------------------+------------
 ```
 
 ### Config
 
 Dump the config:
 ```bash
-bonvoy config dump auth-grpc
+$ bonvoy config dump products-grpc
+
+# configuration dumped here in JSON format
 ```
 
 ### Server
 
 Output server information:
 ```bash
-bonvoy server info auth-grpc
+$ bonvoy server info products-grpc
+
+----------------------
+- Server Information -
+----------------------
+  Service             | products-grpc
+  Envoy Pid           | 14013
+  Version             | asdf/1.22.0/Clean/RELEASE/BoringSSL
+  Hot Restart Version | disabled
+  State               | LIVE
+  Uptime              | 1115062s
+
+--------------------
+- Node Information -
+--------------------
+  Node ID       | _nomad-task-asdf-group-products-grpc-sidecar-proxy
+  Node Cluster  | products-grpc
+  User Agent    | envoy
+  Envoy Version | 1.22.0
+  Namespace     | default
+
+------------------------
+- Command Line Options -
+------------------------
+  Concurrency          | 24
+  Mode                 | Serve
+  Log Level            | info
+  Component Log Level  |
+  Log Format           | [%Y-%m-%d %T.%e][%t][%l][%n]
+                       | [%g:%#] %v
+  Drain Strategy       | Gradual
+  Drain Time           | 100s
+  Config Path          | /path/to/envoy_bootstrap.json
+  Parent Shutdown Time | 200s
 ```
 
 Show server memory statistics:
 ```bash
-bonvoy server memory auth-grpc
+$ bonvoy server memory products-grpc
+
+----------------------
+- Server Memory Info -
+----------------------
+  Service              | products-grpc
+  Envoy Pid            | 14013
+  Allocated            | 16349720
+  Heap Size            | 41943040
+  Page Heap (Unmapped) | 0
+  Page Heap (Free)     | 3317760
+  Total Physical Bytes | 43894086
+  Total Thread Cache   | 20066256
 ```
 
 ### Logging
 
 Set the log level for a sidecar:
 ```bash
-bonvoy log level auth-grpc -l debug
-```
+$ bonvoy log level products-grpc -l debug
+```
+
+## License
+
+Copyright (c) 2021-present, BigCommerce Pty. Ltd. All rights reserved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.