CDI-180: Implement Code Generation for PingFederate Resource Export

.github/workflows/code-analysis-lint-test.yaml

@@ -123,7 +123,6 @@ jobs:
     needs: [build]
     runs-on: ubuntu-latest
     env:
-      PING_IDENTITY_CONFIG: ${{ secrets.PING_IDENTITY_CONFIG }}
       PINGCLI_PINGONE_WORKER_CLIENT_ID: ${{ secrets.PINGCLI_PINGONE_WORKER_CLIENT_ID }}
       PINGCLI_PINGONE_WORKER_CLIENT_SECRET: ${{ secrets.PINGCLI_PINGONE_WORKER_CLIENT_SECRET }}
       PINGCLI_PINGONE_REGION_CODE: ${{ secrets.PINGCLI_PINGONE_REGION_CODE }}
@@ -145,6 +144,9 @@ jobs:
       PINGCLI_PINGFEDERATE_TOKEN_URL: ${{ secrets.PINGCLI_PINGFEDERATE_TOKEN_URL }}
       PINGCLI_PINGFEDERATE_USERNAME: ${{ secrets.PINGCLI_PINGFEDERATE_USERNAME }}
       PINGCLI_PINGFEDERATE_PROVIDER_VERSION: ${{ vars.PINGCLI_PINGFEDERATE_PROVIDER_VERSION }}
+      PING_IDENTITY_DEVOPS_USER: ${{ secrets.PING_IDENTITY_DEVOPS_USER }}
+      PING_IDENTITY_DEVOPS_KEY: ${{ secrets.PING_IDENTITY_DEVOPS_KEY }}
+      PING_IDENTITY_ACCEPT_EULA: ${{ vars.PING_IDENTITY_ACCEPT_EULA }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
@@ -154,4 +156,4 @@ jobs:
       - uses: hashicorp/setup-terraform@v3
         with:
           terraform_wrapper: false
-      - run: mkdir -p $HOME/.pingidentity/ && echo "$PING_IDENTITY_CONFIG" >> $HOME/.pingidentity/config && grep -E "[a-zA-Z]" $HOME/.pingidentity/config || exit 1 && make starttestcontainer && make test && make removetestcontainer
+      - run: make starttestcontainer && make test && make removetestcontainer

Makefile

@@ -1,59 +1,177 @@
 SHELL := /bin/bash
 
-.PHONY: install fmt vet test devchecknotest devcheck importfmtlint
+.PHONY: install fmt vet test devchecknotest devcheck importfmtlint golangcilint starttestcontainer removetestcontainer spincontainer openlocalwebapi openapp
 
 default: install
 
 install:
-	go mod tidy
-	go install .
+	@echo -n "Running 'go mod tidy' to ensure all dependencies are up to date..."
+	@if go mod tidy; then \
+        echo " SUCCESS"; \
+    else \
+        echo " FAILED"; \
+        exit 1; \
+    fi
+
+	@echo -n "Running 'go install' to install pingcli..."
+	@if go install .; then \
+		echo " SUCCESS"; \
+	else \
+		echo " FAILED"; \
+		exit 1; \
+	fi
 
 fmt:
-	go fmt ./...
+	@echo -n "Running 'go fmt' to format the code..."
+	@if go fmt ./...; then \
+		echo " SUCCESS"; \
+	else \
+		echo " FAILED"; \
+		exit 1; \
+	fi
 
 vet:
-	go vet ./...
+	@echo -n "Running 'go vet' to check for potential issues..."
+	@if go vet ./...; then \
+		echo " SUCCESS"; \
+	else \
+		echo " FAILED"; \
+		exit 1; \
+	fi
+
+test: --test-cmd --test-internal-commands --test-internal-configuration --test-internal-connector --test-internal-customtypes --test-internal-input --test-internal-profiles
+
+--test-cmd:
+	@echo "Running tests for cmd..."
+	@go test -count=1 ./cmd/...
+
+--test-internal-commands:
+	@echo "Running tests for internal/commands..."
+	@go test -count=1 ./internal/commands/...
+
+--test-internal-configuration:
+	@echo "Running tests for internal/configuration..."
+	@go test -count=1 ./internal/configuration/...
+
+--test-internal-connector:
+	@echo "Running tests for internal/connector..."
+
+	@# Test each connector package separately to avoid configuration collision
+	@go test -count=1 ./internal/connector
+
+	@# Test the resources within each connector first
+	@go test -count=1 ./internal/connector/pingfederate/resources
+	@go test -count=1 ./internal/connector/pingone/.../resources
 
-test:
-	go test -parallel=4 -count=1 ./...
+	@# Test the connectors itegration terraform plan tests
+	@go test -count=1 ./internal/connector/pingfederate
+	@go test -count=1 ./internal/connector/pingone/*/
+
+--test-internal-customtypes:
+	@echo "Running tests for internal/customtypes..."
+	@go test -count=1 ./internal/customtypes/...
+
+--test-internal-input:
+	@echo "Running tests for internal/input..."
+	@go test -count=1 ./internal/input/...
+
+--test-internal-profiles:
+	@echo "Running tests for internal/profiles..."
+	@go test -count=1 ./internal/profiles/...
 
 devchecknotest: install importfmtlint fmt vet golangcilint
 
 devcheck: devchecknotest spincontainer test removetestcontainer
 
 importfmtlint:
-	impi --local . --scheme stdThirdPartyLocal ./...
+	@echo -n "Running 'impi' to format import ordering..."
+	@if impi --local . --scheme stdThirdPartyLocal ./...; then \
+		echo " SUCCESS"; \
+	else \
+		echo " FAILED"; \
+		exit 1; \
+	fi
 
 golangcilint:
-	golangci-lint run --timeout 5m ./...
+	@echo -n "Running 'golangci-lint' to check for code quality issues..."
+	@# Clear the cache for every run, so that the linter outputs the same results as the GH Actions workflow
+	@if golangci-lint cache clear && golangci-lint run --timeout 5m ./...; then \
+		echo " SUCCESS"; \
+	else \
+		echo " FAILED"; \
+		exit 1; \
+	fi
+
+starttestcontainer: --checkneededpfenvvars --checkdocker --dockerrunpf --waitforpfhealthy
 
-starttestcontainer:
-	docker run --name pingfederate_terraform_provider_container \
+--checkneededpfenvvars:
+	@echo -n "Checking for required environment variables to run PingFederate container..."
+	@test -n "$$PING_IDENTITY_DEVOPS_USER" || { echo " FAILED"; echo "PING_IDENTITY_DEVOPS_USER environment variable is not set.\n\nNot Registered? Register for the DevOps Program at https://devops.pingidentity.com/how-to/devopsRegistration/."; exit 1; }
+	@test -n "$$PING_IDENTITY_DEVOPS_KEY" || { echo " FAILED"; echo "PING_IDENTITY_DEVOPS_KEY environment variable is not set.\n\nNot Registered? Register for the DevOps Program at https://devops.pingidentity.com/how-to/devopsRegistration/."; exit 1; }
+	@test "YES" = "$$PING_IDENTITY_ACCEPT_EULA" || { echo " FAILED"; echo "You must accept the EULA to use the PingFederate container. Set PING_IDENTITY_ACCEPT_EULA=YES to continue."; exit 1; }
+	@echo " SUCCESS"
+
+--checkdocker:
+	@echo -n "Checking if Docker is running..."
+	@docker info > /dev/null 2>&1 || { echo " FAILED"; echo "Docker is not running. Please start Docker and try again."; exit 1; }
+	@echo " SUCCESS"
+
+--dockerrunpf:
+	@echo -n "Starting the PingFederate container..."
+	@docker run --name pingcli_test_pingfederate_container \
 		-d -p 9031:9031 \
 		-p 9999:9999 \
-		--env-file "${HOME}/.pingidentity/config" \
-		-v $$(pwd)/server-profiles/shared-profile:/opt/in \
-		-v $$(pwd)/server-profiles/12.2/data.json:/opt/in/instance/bulk-config/data.json \
-		pingidentity/pingfederate:12.2.0-latest
-# Wait for the instance to become ready
-	sleep 1
-	duration=0
-	while (( duration < 240 )) && ! docker logs pingfederate_terraform_provider_container 2>&1 | grep -q "Removing Imported Bulk File\|CONTAINER FAILURE"; \
-	do \
-	    duration=$$((duration+1)); \
+		--env PING_IDENTITY_DEVOPS_USER="$${PING_IDENTITY_DEVOPS_USER}" \
+		--env PING_IDENTITY_DEVOPS_KEY="$${PING_IDENTITY_DEVOPS_KEY}" \
+		--env PING_IDENTITY_ACCEPT_EULA="$${PING_IDENTITY_ACCEPT_EULA}" \
+		--env CREATE_INITIAL_ADMIN_USER="true" \
+		-v $$(pwd)/internal/testing/pingfederate_container_files/deploy:/opt/in/instance/server/default/deploy \
+		pingidentity/pingfederate:latest > /dev/null 2>&1 || { echo " FAILED"; echo "Failed to start the PingFederate container. Please check your Docker setup."; exit 1; }
+	@echo " SUCCESS"
+
+--waitforpfhealthy:
+	@echo -n "Waiting for the PingFederate container to become healthy..."
+	@timeout=240; \
+	while test $$timeout -gt 0; do \
+		status=$$(docker inspect --format='{{json .State.Health.Status}}' pingcli_test_pingfederate_container 2>/dev/null || echo ""); \
+		if test "$$status" = '"healthy"'; then \
+			echo " SUCCESS"; \
+			exit 0; \
+		fi; \
 		sleep 1; \
-	done
-# Fail if the container didn't become ready in time
-	docker logs pingfederate_terraform_provider_container 2>&1 | grep -q "Removing Imported Bulk File" || \
-		{ echo "PingFederate container did not become ready in time or contains errors. Logs:"; docker logs pingfederate_terraform_provider_container; exit 1; }
+		timeout=$$((timeout - 1)); \
+	done; \
+	echo " FAILED"; \
+	echo "PingFederate container did not become healthy within the timeout period."; \
+	echo "Current status: $$status"; \
+	docker logs pingcli_test_pingfederate_container || echo "No logs available."; \
+	exit 1
 
-removetestcontainer:
-	docker rm -f pingfederate_terraform_provider_container
+removetestcontainer: --checkdocker
+	@echo -n "Stopping and removing the PingFederate container..."
+	@if docker rm -f pingcli_test_pingfederate_container > /dev/null 2>&1; then \
+		echo " SUCCESS"; \
+	else \
+		echo " FAILED"; \
+		exit 1; \
+	fi
 
 spincontainer: removetestcontainer starttestcontainer
 
 openlocalwebapi:
-	open "https://localhost:9999/pf-admin-api/api-docs/#/"
+	@echo -n "Opening the PingFederate Admin API documentation in the default web browser..."
+	@if open "https://localhost:9999/pf-admin-api/api-docs/#/"; then \
+		echo " SUCCESS"; \
+	else \
+		echo " FAILED"; \
+		exit 1; \
+	fi
 
 openapp:
-	open "https://localhost:9999/pingfederate/app"
+	@echo -n "Opening the PingFederate Admin Console in the default web browser..."
+	@if open "https://localhost:9999/pingfederate/app"; then \
+		echo " SUCCESS"; \
+	else \
+		echo " FAILED"; \
+		exit 1; \
+	fi

cmd/config/get_test.go

@@ -77,11 +77,11 @@ func Example_getEmptyMaskedValue() {
 // https://pkg.go.dev/testing#hdr-Examples
 func Example_getMaskedValue() {
 	t := testing.T{}
-	_ = testutils_cobra.ExecutePingcli(&t, "config", "get", options.PingFederateClientCredentialsAuthClientSecretOption.ViperKey)
+	_ = testutils_cobra.ExecutePingcli(&t, "config", "get", options.PingFederateBasicAuthPasswordOption.ViperKey)
 
 	// Output:
-	// Configuration values for profile 'default' and key 'service.pingfederate.authentication.clientCredentialsAuth.clientSecret':
-	// service.pingfederate.authentication.clientCredentialsAuth.clientSecret=********
+	// Configuration values for profile 'default' and key 'service.pingfederate.authentication.basicAuth.password':
+	// service.pingfederate.authentication.basicAuth.password=********
 }
 
 // https://pkg.go.dev/testing#hdr-Examples