Feature/regex matching

.github/tasks/test.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -eux
+
+function main() {
+  ./scripts/test
+}
+
+main "$@"

.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - feature/regex-matching
+
+jobs:
+  unit-tests:
+    container:
+      image: pivotalcfreleng/golang
+
+    timeout-minutes: 90
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      - uses: actions/checkout@v2
+      - id: run_unit_tests
+        name: Run unit tests
+        run: .github/tasks/test.sh

README.md

@@ -1,3 +1,7 @@
+# This README is for the github.com/notrepo05/leftovers fork from github.com/genevieve/leftovers
+
+### This fork aims to stabilize deletion (so far for AWS) and add extended regex filtering support.
+
 # Leftovers :turkey:
 
 [![GoDoc](https://godoc.org/github.com/genevieve/leftovers?status.svg)](https://godoc.org/github.com/genevieve/leftovers)
@@ -18,6 +22,7 @@ Go cli & library for cleaning up **orphaned IaaS resources**.
 - Your acceptance tests in CI failed, the container disappeared, and
 infrastructure resources were tragically orphaned. :-(
 - `terraform destroy` isn't working because the refresh step is failing due to a missing resource.
+- You're too lazy to `terraform destroy`
 
 
 
@@ -49,7 +54,7 @@ $ leftovers --filter banana --dry-run
 ```
 
 
-Finally, you might want to delete a single resource type::
+You might want to delete a single resource type::
 ```console
 $ leftovers types
 service-account
@@ -59,34 +64,31 @@ $ leftovers --filter banana --type service-account --no-confirm
 [Service Account: banana@pivotal.io] Deleted!
 ```
 
-
+Or you might want to filter using regex (this is a beta feature)
+```console
+$ BBL_IAAS=gcp leftovers --gcp-service-account-key="gcp-service-account.json" --filter '^(?=.*pull-1234)(?!.*iless-).*' --filter-as-regex --dry-run
+[Compute Instance: vm-137e7129-aaa-bbb-cccc-e3ddb3aaec23 (pull-1234-pcf-network, cf-1234567890abc1234567, cf-1234567890abc1234567-control, control, p-bosh, p-bosh-cf-1234567890abc1234567, p-bosh-cf-1234567890abc1234567-control, pcf-lb, pull-1234-cf-ssh, pull-1234-vms)]
+```
 
 ## <a name='how'></a>Installation
 
 ### Option 1
 [Install go.](https://golang.org/doc/install) Then:
 
 ```console
-$ go get -u github.com/genevieve/leftovers/cmd/leftovers
+$ go get -u github.com/notrepo05/leftovers/cmd/leftovers
 ```
 
 ### Option 2
 
-```console
-$ brew tap genevieve/tap
-$ brew install leftovers
-```
-
-### Option 3
-
-Linux binaries can be found on the [releases page](https://github.com/genevieve/leftovers/releases).
+Linux and OSX binaries for this fork can be found on the [releases page](https://github.com/notrepo05/leftovers/releases).
 
 
 
 ## <a name='how'></a>Usage
 
 ```console
-$ leftovers -h
+$ ./leftovers --help
 
 Usage:
   leftovers [OPTIONS]
@@ -97,7 +99,9 @@ Application Options:
   -n, --no-confirm                Destroy resources without prompting. This is dangerous, make good choices!
   -d, --dry-run                   List all resources without deleting any.
   -f, --filter=                   Filtering resources by an environment name.
+      --filter-as-regex           Interpret the filter as regex. (**This is a beta feature** Tested on AWS, Azure, and GCP)
   -t, --type=                     Type of resource to delete.
+      --debug                     Print debug information.
       --aws-access-key-id=        AWS access key id. [$BBL_AWS_ACCESS_KEY_ID]
       --aws-secret-access-key=    AWS secret access key. [$BBL_AWS_SECRET_ACCESS_KEY]
       --aws-session-token=        AWS session token. [$BBL_AWS_SESSION_TOKEN]
@@ -125,7 +129,7 @@ Help Options:
   -h, --help                      Show this help message
 ```
 
-## <a name='maintainers'></a>Maintainers
+## <a name='maintainers'></a>Maintainers of the actual project
 
 - [Genevieve L'Esperance](https://twitter.com/genevieve_vl)
 - [Rowan Jacobs](https://github.com/rowanjacobs)

acceptance/aws_test.go

@@ -19,6 +19,7 @@ var _ = Describe("AWS", func() {
 
 		stdout  *bytes.Buffer
 		filter  string
+		regexFilter string
 		deleter aws.Leftovers
 	)
 
@@ -45,16 +46,17 @@ var _ = Describe("AWS", func() {
 	Describe("List", func() {
 		BeforeEach(func() {
 			filter = "leftovers-acc-list-all"
+			regexFilter = "leftovers-acc-lis[t]{1}-a[l]{2}$"
 			acc.CreateKeyPair(filter)
 		})
 
 		AfterEach(func() {
-			err := deleter.Delete(filter)
+			err := deleter.Delete(filter, false)
 			Expect(err).NotTo(HaveOccurred())
 		})
 
 		It("lists resources without deleting", func() {
-			deleter.List(filter)
+			deleter.List(filter, false)
 
 			Expect(stdout.String()).To(ContainSubstring("[EC2 Key Pair: %s]", filter))
 			Expect(stdout.String()).NotTo(ContainSubstring("[EC2 Key Pair: %s] Deleting...", filter))
@@ -65,16 +67,25 @@ var _ = Describe("AWS", func() {
 	Describe("ListByType", func() {
 		BeforeEach(func() {
 			filter = "leftovers-acc-list-by-type"
+			regexFilter = "leftovers-acc-lis[t]{1}-b[y]{1}-type$"
 			acc.CreateKeyPair(filter)
 		})
 
 		AfterEach(func() {
-			err := deleter.Delete(filter)
+			err := deleter.Delete(filter, false)
 			Expect(err).NotTo(HaveOccurred())
 		})
 
 		It("lists resources of the specified type without deleting", func() {
-			deleter.List(filter)
+			deleter.List(filter, false)
+
+			Expect(stdout.String()).To(ContainSubstring("[EC2 Key Pair: %s]", filter))
+			Expect(stdout.String()).NotTo(ContainSubstring("[EC2 Key Pair: %s] Deleting...", filter))
+			Expect(stdout.String()).NotTo(ContainSubstring("[EC2 Key Pair: %s] Deleted!", filter))
+		})
+
+		It("lists resources of the specified type without deleting with the regex filter", func() {
+			deleter.List(filter, true)
 
 			Expect(stdout.String()).To(ContainSubstring("[EC2 Key Pair: %s]", filter))
 			Expect(stdout.String()).NotTo(ContainSubstring("[EC2 Key Pair: %s] Deleting...", filter))
@@ -93,11 +104,21 @@ var _ = Describe("AWS", func() {
 	Describe("Delete", func() {
 		BeforeEach(func() {
 			filter = "leftovers-acc-delete-all"
+			regexFilter = "leftovers-acc-dele[t]{1}e-a[l]{2}$"
 			acc.CreateKeyPair(filter)
 		})
 
 		It("deletes resources with the filter", func() {
-			err := deleter.Delete(filter)
+			err := deleter.Delete(filter, false)
+			Expect(err).NotTo(HaveOccurred())
+
+			Expect(stdout.String()).To(ContainSubstring("[EC2 Key Pair: %s] Deleting...", filter))
+			Expect(stdout.String()).To(ContainSubstring("[EC2 Key Pair: %s] Deleted!", filter))
+		})
+
+
+		It("deletes resources with the regex filter", func() {
+			err := deleter.Delete(regexFilter, true)
 			Expect(err).NotTo(HaveOccurred())
 
 			Expect(stdout.String()).To(ContainSubstring("[EC2 Key Pair: %s] Deleting...", filter))
@@ -108,11 +129,20 @@ var _ = Describe("AWS", func() {
 	Describe("DeleteByType", func() {
 		BeforeEach(func() {
 			filter = "leftovers-acc-delete-type"
+			regexFilter = "leftovers-acc-dele[t]{1}e-type"
 			acc.CreateKeyPair(filter)
 		})
 
 		It("deletes the key pair resources with the filter", func() {
-			err := deleter.DeleteByType(filter, "ec2-key-pair")
+			err := deleter.DeleteByType(filter, "ec2-key-pair", false)
+			Expect(err).NotTo(HaveOccurred())
+
+			Expect(stdout.String()).To(ContainSubstring("[EC2 Key Pair: %s] Deleting...", filter))
+			Expect(stdout.String()).To(ContainSubstring("[EC2 Key Pair: %s] Deleted!", filter))
+		})
+
+		It("deletes resources with the regex filter", func() {
+			err := deleter.DeleteByType(regexFilter, "ec2-key-pair", true)
 			Expect(err).NotTo(HaveOccurred())
 
 			Expect(stdout.String()).To(ContainSubstring("[EC2 Key Pair: %s] Deleting...", filter))

acceptance/azure_test.go

@@ -19,6 +19,7 @@ var _ = Describe("Azure", func() {
 		stdout  *bytes.Buffer
 		filter  string
 		deleter azure.Leftovers
+		regexFilter string
 	)
 
 	BeforeEach(func() {
@@ -44,16 +45,25 @@ var _ = Describe("Azure", func() {
 	Describe("List", func() {
 		BeforeEach(func() {
 			filter = "leftovers-acc-list"
+			regexFilter = "leftovers-acc-lis[t]{1}"
 			acc.CreateResourceGroup(filter)
 		})
 
 		AfterEach(func() {
-			err := deleter.Delete(filter)
+			err := deleter.Delete(filter, false)
 			Expect(err).NotTo(HaveOccurred())
 		})
 
 		It("lists resources without deleting", func() {
-			deleter.List(filter)
+			deleter.List(filter, false)
+
+			Expect(stdout.String()).To(ContainSubstring("[Resource Group: %s]", filter))
+			Expect(stdout.String()).To(ContainSubstring("Listing Resource Groups..."))
+			Expect(stdout.String()).NotTo(ContainSubstring("[Resource Group: %s] Deleting...", filter))
+		})
+
+		It("lists resources without deleting filtered by regex", func() {
+			deleter.List(regexFilter, true)
 
 			Expect(stdout.String()).To(ContainSubstring("[Resource Group: %s]", filter))
 			Expect(stdout.String()).To(ContainSubstring("Listing Resource Groups..."))
@@ -72,11 +82,20 @@ var _ = Describe("Azure", func() {
 	Describe("Delete", func() {
 		BeforeEach(func() {
 			filter = "leftovers-acc-delete"
+			regexFilter = "leftovers-acc-dele[t]{1}e"
 			acc.CreateResourceGroup(filter)
 		})
 
 		It("deletes resources with the filter", func() {
-			err := deleter.Delete(filter)
+			err := deleter.Delete(filter, false)
+			Expect(err).NotTo(HaveOccurred())
+
+			Expect(stdout.String()).To(ContainSubstring("[Resource Group: %s] Deleting...", filter))
+			Expect(stdout.String()).To(ContainSubstring("[Resource Group: %s] Deleted!", filter))
+		})
+
+		It("deletes resources with the regex filter", func() {
+			err := deleter.Delete(regexFilter, true)
 			Expect(err).NotTo(HaveOccurred())
 
 			Expect(stdout.String()).To(ContainSubstring("[Resource Group: %s] Deleting...", filter))
@@ -91,7 +110,7 @@ var _ = Describe("Azure", func() {
 			})
 
 			PIt("prompts them for subresources after they say no to the resource group", func() {
-				err := deleter.Delete(filter)
+				err := deleter.Delete(filter, false)
 				Expect(err).NotTo(HaveOccurred())
 
 				Expect(stdout.String()).NotTo(ContainSubstring("[Resource Group: %s] Deleting...", filter))