Initial fork of Probr->Privateer

eddie-knight · eddie-knight · commit 19c7ccf162ad · 2022-10-30T07:32:18.000-05:00
Signed-off-by: Eddie Knight &lt;knight@linux.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -246,10 +246,10 @@ node_modules
 # VS Code debugger
 __debug_bin
 
-# probr misc ('probr' is Linux exe)
-probr_output
+# privateer misc ('privateer' is Linux exe)
+privateer_output
 !examples/*
-probr
+privateer
 static-content/
 .kube/
 config.yml
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1,4 +1,4 @@
 # All PRs in this repository will be blocked
 # until they have been approved by a maintainer
 
-* @probr/maintainers
+* @eddie-knight
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing to Probr
+# Contributing to Privateer
 
 We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
 
@@ -8,7 +8,7 @@ Participation in this project comes under the [Contributor Covenant Code of Cond
 
 ## Code Submission
 
-Thank you for considering submitting code to Probr!
+Thank you for considering submitting code to Privateer!
 
 - We follow the [GitHub Pull Request Model](https://help.github.com/articles/about-pull-requests/) for all contributions.
 - For large bodies of work, we recommend creating an issue using the "Feature Request" template to outline the feature that you wish to build, and describe how it will be implemented. This gives a chance for review to happen early, and ensures no wasted effort occurs.
@@ -36,8 +36,8 @@ When submitting pull requests, make sure to do the following:
 
 ## Continuous Integration
 
-Probr uses Github Actions for all CI tasks. You may review the existing workflows in `.github/workflows`. Results of checks will automatically be pushed to PRs and may block merging if checks fail.
+Privateer uses Github Actions for all CI tasks. You may review the existing workflows in `.github/workflows`. Results of checks will automatically be pushed to PRs and may block merging if checks fail.
 
 ## Logging
 
-Probr is extremely dependent on clean and clear logs for its success. Please follow the [Log Filter Guidelines](internal/config/README.md) to add useful logs to your code.
+Privateer is extremely dependent on clean and clear logs for its success. Please follow the [Log Filter Guidelines](internal/config/README.md) to add useful logs to your code.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# Probr Service Pack Wireframe
+# Privateer Raid Wireframe
 
 This wireframe is designed to quickly get your service pack repository up to speed!
 
-Probr's plugin architecture relies on some key elements being present at the top level of the service pack,
-all of which are provided along with examle code in this repo.
+Privateer's plugin architecture relies on some key elements being present at the top level
+of the service pack, all of which are provided along with examle code in this repo.
 
 Simply fork or clone this repo and start adjusting the tests to build your own service pack!
diff --git a/TESTING.md b/TESTING.md
@@ -1,6 +1,6 @@
 # Testing
 
-This doc describes required steps and tools to successfully implement testing strategy for all Probr components.
+This doc describes required steps and tools to successfully implement testing strategy for all Privateer components.
 Assumptions:
 - VS Code is used as the local IDE
 - Go built-in testing package is used
@@ -170,7 +170,7 @@ The following structure is recommended:
         --- PASS: TestSum/TestCase#3 (0.00s)
         --- PASS: TestSum/TestCase#4 (0.00s)
     PASS
-    ok      github.com/probr/probr-sdk/utils 0.227s
+    ok      github.com/privateerproj/privateer-sdk/utils 0.227s
     ```
 
 - Autogenerate tests with *gotest tool*
@@ -218,7 +218,7 @@ The following structure is recommended:
       --- PASS: TestSum/TestCase1_AddingTwoPositiveNumbers_ShouldReturnSum (0.00s)
       --- PASS: TestSum/TestCase2_AddingZeroToNumber_ShouldReturnNumber (0.00s)
   PASS
-  ok      github.com/probr/probr-sdk/utils 0.223s
+  ok      github.com/privateerproj/privateer-sdk/utils 0.223s
   ```
 
 
diff --git a/go.mod b/go.mod
@@ -1,13 +1,13 @@
-module github.com/probr/probr-pack-wireframe
+module github.com/privateerproj/privateer-pack-wireframe
 
 go 1.14
 
 require (
 	github.com/cucumber/godog v0.11.0
 	github.com/hashicorp/go-hclog v0.15.0 // indirect
 	github.com/markbates/pkger v0.17.1
-	github.com/probr/probr-sdk v0.1.6
+	github.com/privateerproj/privateer-sdk v0.0.0
 )
 
 // For Development Only
-// replace github.com/probr/probr-sdk => ../probr-sdk
+replace github.com/privateerproj/privateer-sdk => ../privateer-sdk
diff --git a/go.sum b/go.sum
@@ -399,8 +399,6 @@ github.com/pkg/profile v1.2.1/go.mod h1:hJw3o1OdXxsrSjjVksARp5W95eeEaEfptyVZyv6J
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/posener/complete v1.1.1/go.mod h1:em0nMJCgc9GFtwrmVmEMR/ZL6WyhyjMBndrE9hABlRI=
-github.com/probr/probr-sdk v0.1.6 h1:NSv106oUtCOXCbj6tuDvEvsmiL8uHoxakWgVbC/C4Js=
-github.com/probr/probr-sdk v0.1.6/go.mod h1:Cp/BmkTE08Q0Kw+t3YcVn89ZjMuET2sSeEKsYEiYTFQ=
 github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw=
 github.com/prometheus/client_golang v0.9.2/go.mod h1:OsXs2jCmiKlQ1lTBmv21f2mNfw4xf/QclQDMrYNZzcM=
 github.com/prometheus/client_golang v0.9.3-0.20190127221311-3c4408c8b829/go.mod h1:p2iRAGwDERtqlqzRXnrOVns+ignqQo//hLXqYxZYVNs=
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -4,9 +4,9 @@ import (
 	"encoding/json"
 	"log"
 
-	sdkConfig "github.com/probr/probr-sdk/config"
-	"github.com/probr/probr-sdk/config/setter"
-	"github.com/probr/probr-sdk/utils"
+	sdkConfig "github.com/privateerproj/privateer-sdk/config"
+	"github.com/privateerproj/privateer-sdk/config/setter"
+	"github.com/privateerproj/privateer-sdk/utils"
 )
 
 // Vars is a stateful object containing the variables required to execute this pack
@@ -27,15 +27,15 @@ func (ctx *varOptions) Init() (err error) {
 	sdkConfig.GlobalConfig.Init()
 	sdkConfig.GlobalConfig.PrepareOutputDirectory("audit", "cucumber")
 
-	ctx.ServicePacks.Wireframe.setEnvAndDefaults()
+	ctx.Raids.Wireframe.setEnvAndDefaults()
 
 	log.Printf("[DEBUG] Config initialized by %s", utils.CallerName(1))
 	return
 }
 
 // decode uses an SDK helper to create a YAML file decoder,
 // parse the file to an object, then extracts the values from
-// ServicePacks.Wireframe into this context
+// Raids.Wireframe into this context
 func (ctx *varOptions) decode() (err error) {
 	configDecoder, file, err := sdkConfig.NewConfigDecoder(ctx.VarsFile)
 	if err != nil {
@@ -53,7 +53,7 @@ func (ctx *varOptions) LogConfigState() {
 }
 
 func (ctx *varOptions) Tags() string {
-	return sdkConfig.ParseTags(ctx.ServicePacks.Wireframe.TagInclusions, ctx.ServicePacks.Wireframe.TagExclusions)
+	return sdkConfig.ParseTags(ctx.Raids.Wireframe.TagInclusions, ctx.Raids.Wireframe.TagExclusions)
 }
 
 // setEnvOrDefaults will set value from os.Getenv and default to the specified value
diff --git a/internal/config/types.go b/internal/config/types.go
@@ -1,9 +1,9 @@
 package config
 
 type varOptions struct {
-	VarsFile     string       // Required to initialize the sdk global config object
-	Verbose      bool         // Recommended for flag handling
-	ServicePacks servicePacks `yaml:"ServicePacks"` // Optional
+	VarsFile string       // Required to initialize the sdk global config object
+	Verbose  bool         // Recommended for flag handling
+	Raids    servicePacks `yaml:"Raids"` // Optional
 }
 
 // servicePacks is only required if this pack accepts custom vars
diff --git a/internal/summary/summary.go b/internal/summary/summary.go
@@ -1,7 +1,7 @@
 package summary
 
 import (
-	audit "github.com/probr/probr-sdk/audit"
+	audit "github.com/privateerproj/privateer-sdk/audit"
 )
 
 // State should be set in the pack's runtime via audit.NewSummaryState
diff --git a/internal/welcome/welcome.go b/internal/welcome/welcome.go
@@ -4,11 +4,11 @@ package welcome
 import (
 	"github.com/cucumber/godog"
 
-	"github.com/probr/probr-pack-wireframe/internal/config"
-	"github.com/probr/probr-pack-wireframe/internal/summary"
-	audit "github.com/probr/probr-sdk/audit"
-	"github.com/probr/probr-sdk/probeengine"
-	"github.com/probr/probr-sdk/utils"
+	"github.com/privateerproj/privateer-pack-wireframe/internal/config"
+	"github.com/privateerproj/privateer-pack-wireframe/internal/summary"
+	audit "github.com/privateerproj/privateer-sdk/audit"
+	"github.com/privateerproj/privateer-sdk/probeengine"
+	"github.com/privateerproj/privateer-sdk/utils"
 )
 
 type probeStruct struct{}
@@ -40,11 +40,11 @@ func (scenario *scenarioState) testShouldRun() error {
 	payload = struct {
 		TestShouldPass string
 	}{
-		config.Vars.ServicePacks.Wireframe.Pass,
+		config.Vars.Raids.Wireframe.Pass,
 	}
 
-	if config.Vars.ServicePacks.Wireframe.Pass == "false" {
-		err = utils.ReformatError("Config state ServicePacks.Wireframe.Pass was false")
+	if config.Vars.Raids.Wireframe.Pass == "false" {
+		err = utils.ReformatError("Config state Raids.Wireframe.Pass was false")
 	}
 
 	return err
@@ -108,7 +108,7 @@ func (probe probeStruct) Name() string {
 	// The return value for `Name` should match the probe directory
 	// and it's feature file, so each may be properly addressed for
 	// packing and opening the files.
-	return "wireframe"
+	return "welcome"
 }
 
 // Path presents the path of these feature files for external reference
diff --git a/main.go b/main.go
@@ -9,21 +9,21 @@ import (
 	"os/signal"
 	"syscall"
 
-	"github.com/probr/probr-pack-wireframe/internal/config"
-	"github.com/probr/probr-pack-wireframe/internal/summary"
-	"github.com/probr/probr-pack-wireframe/pack"
-
-	audit "github.com/probr/probr-sdk/audit"
-	sdkConfig "github.com/probr/probr-sdk/config"
-	"github.com/probr/probr-sdk/plugin"
-	probeengine "github.com/probr/probr-sdk/probeengine"
-	"github.com/probr/probr-sdk/utils"
+	"github.com/privateerproj/privateer-pack-wireframe/internal/config"
+	"github.com/privateerproj/privateer-pack-wireframe/internal/summary"
+	"github.com/privateerproj/privateer-pack-wireframe/pack"
+
+	audit "github.com/privateerproj/privateer-sdk/audit"
+	sdkConfig "github.com/privateerproj/privateer-sdk/config"
+	"github.com/privateerproj/privateer-sdk/plugin"
+	probeengine "github.com/privateerproj/privateer-sdk/probeengine"
+	"github.com/privateerproj/privateer-sdk/utils"
 )
 
 var (
-	// ServicePackName is the name for the service pack
+	// RaidName is the name for the service pack
 	// TODO: Return binary name instead? Or add this to the interface to use instead of the binary name?
-	ServicePackName = "Wireframe"
+	RaidName = "Wireframe"
 
 	// Version is the main version number that is being run at the moment
 	Version = "0.1.0"
@@ -43,13 +43,13 @@ var (
 	BuiltAt = ""
 )
 
-// ServicePack ...
-type ServicePack struct {
+// Raid ...
+type Raid struct {
 }
 
-// RunProbes is required to meet the Probr Service Pack interface
-func (sp *ServicePack) RunProbes() error {
-	return ProbrCoreLogic()
+// Start is required to meet the Privateer Service Pack interface
+func (sp *Raid) Start() error {
+	return PrivateerCoreLogic()
 }
 
 // main is executed when this file is called as a binary or `go run`
@@ -59,11 +59,11 @@ func main() {
 }
 
 func setFlags() (versionCmd, runCmd *flag.FlagSet) {
-	// > probr version [-v]
+	// > privateer version [-v]
 	versionCmd = flag.NewFlagSet("version", flag.ExitOnError)
-	config.Vars.Verbose = *versionCmd.Bool("v", false, "Display extended version information") // TODO: Harness '-v' in the standard probr execution
+	config.Vars.Verbose = *versionCmd.Bool("v", false, "Display extended version information") // TODO: Harness '-v' in the standard privateer execution
 
-	// > probr
+	// > privateer
 	runCmd = flag.NewFlagSet("run", flag.ExitOnError)
 	runCmd.StringVar(&config.Vars.VarsFile, "varsfile", "", "path to config file")
 	return
@@ -82,16 +82,16 @@ func handleCommands(versionCmd, runCmd *flag.FlagSet) {
 	case "debug": // Same cli args as run. Use this to bypass plugin and execute directly for debugging
 		// Parse cli args
 		runCmd.Parse(os.Args[2:]) // Skip first arg as it will be 'debug'
-		ProbrCoreLogic()
+		PrivateerCoreLogic()
 
 	default:
 		// Parse cli args
 		runCmd.Parse(os.Args[1:])
 
 		// Serve plugin
-		spProbr := &ServicePack{}
+		raid := &Raid{}
 		serveOpts := &plugin.ServeOpts{
-			Pack: spProbr,
+			Pack: raid,
 		}
 
 		plugin.Serve(serveOpts)
@@ -114,22 +114,22 @@ func setupCloseHandler() {
 	}()
 }
 
-// ProbrCoreLogic ...
-func ProbrCoreLogic() (err error) {
+// PrivateerCoreLogic ...
+func PrivateerCoreLogic() (err error) {
 	defer sdkConfig.GlobalConfig.CleanupTmp()
 	setupCloseHandler() // Sigterm protection
 
 	config.Vars.Init()
-	summary.State = audit.NewSummaryState(ServicePackName)
+	summary.State = audit.NewSummaryState(RaidName)
 
-	store := probeengine.NewProbeStore(ServicePackName, config.Vars.Tags(), &summary.State)
+	store := probeengine.NewProbeStore(RaidName, config.Vars.Tags(), &summary.State)
 	s, err := store.RunAllProbes(pack.GetProbes())
 	if err != nil {
 		log.Printf("[ERROR] Error executing tests %v", err)
 		return
 	}
 	log.Printf("[INFO] Overall test completion status: %v", s)
-	summary.State.SetProbrStatus()
+	summary.State.SetPrivateerStatus()
 
 	summary.State.PrintSummary()
 	summary.State.WriteSummary()
@@ -143,7 +143,7 @@ func ProbrCoreLogic() (err error) {
 func printVersion(w io.Writer) {
 
 	if config.Vars.Verbose {
-		fmt.Fprintf(w, "Service Pack : %s", ServicePackName)
+		fmt.Fprintf(w, "Service Pack : %s", RaidName)
 		fmt.Fprintln(w)
 		fmt.Fprintf(w, "Version      : %s", getVersion())
 		fmt.Fprintln(w)
diff --git a/pack/wireframe.go b/pack/wireframe.go
@@ -2,8 +2,8 @@ package pack
 
 import (
 	"github.com/markbates/pkger"
-	"github.com/probr/probr-pack-wireframe/internal/welcome"
-	"github.com/probr/probr-sdk/probeengine"
+	"github.com/privateerproj/privateer-pack-wireframe/internal/welcome"
+	"github.com/privateerproj/privateer-sdk/probeengine"
 )
 
 // GetProbes returns a list of probe objects

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`package summary`
`2`	`2`
`3`	`3`	`import (`
`4`		`- audit "github.com/probr/probr-sdk/audit"`
	`4`	`+ audit "github.com/privateerproj/privateer-sdk/audit"`
`5`	`5`	`)`
`6`	`6`
`7`	`7`	`// State should be set in the pack's runtime via audit.NewSummaryState`