Main: Version 2 API endpoints package for Splunk Observability APIs (#2)

* Version 2 API endpoints package for Splunk Observability APIs (#1)

* update the client and models

* api checks v2

* browser checks v2

* get checks

* get checks

* add parts for variables

* add httpchecksv2

* port checks

* fix testing and move integration tests to own excluded file

* fix integration tests

* snake_case fixes until the API has been adjusted to camelCase

* update models and move integration tests

Co-authored-by: jeremyh <[email protected]>

* update readme for V2

* only check V2 with new testing standards. V1 is unchanged and deprecated.

Co-authored-by: jeremyh <[email protected]>

Author: greatestusername-splunk

.gitignore

@@ -13,3 +13,20 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+# VS Code
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+.DS_Store
+.vscode/settings.json

Makefile

@@ -3,12 +3,12 @@
 PKG_NAME=syntheticsclient
 FILES=./...
 
-default: test
+default: test 
 
-all: clean build test
+all: clean build test 
 
 build: fmtcheck
-	go build
+	go build -tags=unit_tests
 
 clean:
 	@echo "==> Cleaning out old builds "
@@ -22,17 +22,17 @@ fmt:
 
 lint:
 	@echo "==> Checking source code against linters "
-	@GOGC=30 golangci-lint run $(FILES)
+	@GOGC=30 golangci-lint run ./syntheticsclientv2/...
 
 fmtcheck: fmt lint
 
 test: fmtcheck
 	@echo "==> Running all tests"
-	go test $(FILES) -v -timeout=30s -parallel=4 -cover
+	go test $(FILES) -v -tags=unit_tests -timeout=30s -parallel=4 -cover
 
 testacc: clean fmtcheck
 	@echo "==> Running all tests"
-	go test $(FILES) -v -timeout=30s -parallel=8 -cover -coverprofile coverage.txt
+	go test $(FILES) -v -tags=unit_tests -timeout=30s -parallel=8 -cover -coverprofile coverage.txt
 
 sonarqube: testacc
 	docker run -it -v "${PWD}:/usr/src" sonarsource/sonar-scanner-cli

README.md

@@ -6,72 +6,44 @@ A Splunk Synthetics (Formerly Rigor) client for golang.
 
 ## Important Note
 
-This client is used to make the API calls that are mentioned here [Splunk Synthetics (Formerly Rigor) public API](https://monitoring-api.rigor.com/). However, some features are not implemented or publicly available yet. 
+V2 client is used to make API calls and CRUD operations to the Splunk Observability Synthetics endpoints (E.G. [API Tests](https://dev.splunk.com/observability/reference/api/synthetics_api_tests/))
+
+**Deprecated** V1 Client is used to make the API calls for the [Splunk Synthetics (Formerly Rigor) public API](https://monitoring-api.rigor.com/). 
 
 ## Example Usages
 ```go
-package syntheticsclient
+package main
 
 import (
 	"fmt"
-
-	"https://github.com/splunk/syntheticsclient.git"
+	"os"
+	"encoding/json"
+	sc2 "github.com/splunk/syntheticsclient/syntheticsclientv2"
 )
 
 func main() {
 	//Expects a token is available from the API_ACCESS_TOKEN environment variable
+	//Expects a realm (e.g. us1) is available from REALM environment variable
 	token := os.Getenv("API_ACCESS_TOKEN")
+	realm := os.Getenv("REALM")
 
 	//Create your client with the token
-	c := NewClient(token)
-
-	// Initialize your check settings
-	o := CreateHttpCheck{
-	Name:               "test test",
-	Frequency:          5,
-	URL:                "https://www.google.com"}
-
-	// Make the request with your check settings and print result
-  res, _, err := c.CreateHttpCheck(&o)
-	if err != nil {
-		fmt.Println(err)
-	} else {
-		JsonPrint(res)
-	}
-}
-```
-
-Another possibility for initializing your interface is to unmarshal a valid JSON string into the needed struct
-```go
-package syntheticsclient
-
-import (
-	"fmt"
-	"encoding/json"
-
-	"https://github.com/splunk/syntheticsclient.git"
-)
-
-func main() {
-
-	token := os.Getenv("API_ACCESS_TOKEN")
-
-	c := NewClient(token)
+	c := sc2.NewClient(token, realm)
 
-	//Take your ugly (but valid) JSON string as bytes and unmarshal into a CreateBrowserCheck struct
-	jsonData := []byte(`{"name":"test","type":"real_browser","frequency":10,"round_robin":true,"auto_retry":false,"enabled":true,"integrations":[],"http_request_headers":{"User-Agent":"Mozilla/5.0 (X11; Linux x86_64; Rigor) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36"},"notifications":{"sms":false,"call":false,"email":true,"notify_after_failure_count":2,"notify_on_location_failure":true,"muted":false,"notify_who":[{"sms":false,"call":false,"email":true,"type":"user","links":{"self_html":"https://monitoring.rigor.com/admin/users/1"},"id":1}],"notification_windows":[],"escalations":[]},"url":"https://www.google.com/","user_agent":"Mozilla/5.0 (X11; Linux x86_64; Rigor) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36","auto_update_user_agent":true,"viewport":{"width":1366,"height":768},"enforce_ssl_validation":true,"browser":{"type":"chrome"},"dns_overrides":{},"wait_for_full_metrics":true,"tags":[],"blackout_periods":[{"timezone":"Eastern Time (US & Canada)","start_time":"2000-01-01T07:00:00.000Z","end_time":"2000-01-01T14:00:00.000Z","repeat_type":"daily","duration_in_minutes":420,"is_repeat":true,"created_at":"2020-11-11T21:54:32.000Z","updated_at":"2021-03-30T19:02:54.000Z"}],"steps":[],"javascript_files":[],"threshold_monitors":[],"excluded_files":[],"cookies":[],"connection":{"download_bandwidth":20000,"upload_bandwidth":5000,"latency":28,"packet_loss":0}}`)
-	var browserCheckDetail CreateBrowserCheck
-	err := json.Unmarshal(jsonData, &browserCheckDetail)
+	//Take your ugly (but valid) JSON string as bytes and unmarshal into a CreateHttpCheckV2 struct
+	jsonData := []byte(`{"test":{"name":"Testing-HTTP-stuff","type":"http","url":"https://www.splunk.com","location_ids":["aws-us-east-1","aws-ap-northeast-3"],"frequency":10,"scheduling_strategy":"round_robin","active":true,"request_method":"GET","body":null,"headers":[{"name":"supercool","value":"batman"},{"name":"ajx-back","value":"peeko"}]}}`)
+	var httpCheckDetail sc2.HttpCheckV2Input
+	err := json.Unmarshal(jsonData, &httpCheckDetail)
 	if err != nil {
 		fmt.Println(err)
 	}
 
 	//Use your converted JSON to make the request and print
-	res, _, err := c.CreateBrowserCheck(&browserCheckDetail)
+	res, _, err := c.CreateHttpCheckV2(&httpCheckDetail)
 	if err != nil {
 		fmt.Println(err)
 	} else {
-		JsonPrint(res)
+		fmt.Println(res)
 	}
 }
 ```