Skip to content

Commit f24a8f9

Browse files
committed
chore(docs): Update CHANGELOG and add documentation for e2e tests
1 parent abfef4c commit f24a8f9

File tree

5 files changed

+19
-4
lines changed

5 files changed

+19
-4
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
## Features
33
- Added support for enrolling CSRs with [Enrollment Patterns](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Enrollment-Patterns.htm), a new feature introduced in Keyfactor Command 25.1. [Release notes](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReleaseNotes/Release2511.htm)
44
- Usage of `CertificateTemplate` is still supported, but if using Keyfactor Command 25.1 and above, it is recommended to start using Enrollment Patterns in your issuer specification. You may use `EnrollmentPatternId` or `EnrollmentPatternName` in your specification.
5+
- When using ambient credentials, some relevant token claims (subject, issuer, object ID, etc.) are logged for easier debugging and setup for security roles and identity providers.
56

67
## Chores
78
- Updated documentation for using ambient credentials with Azure Kuberentes Services.

e2e/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# End-to-End Test Suite
2+
3+
This is a test suite intended to make it easy to run tests on the command-cert-manager-issuer project. This suite can test the local changes of the command issuer, and it is able to test existing Docker images.
4+
5+
This is currently configured as a Bash script, so it is necessary to run this on a UNIX-compatible machine.
6+
7+
Instructions on how to run the e2e test suite are within the [run_tests.sh](./run_tests.sh) file.

e2e/run_tests.sh

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ HELM_CHART_NAME="command-cert-manager-issuer"
5656
HELM_CHART_VERSION="local" # Uncomment if you want to use the local Helm chart
5757

5858
IS_LOCAL_DEPLOYMENT=$([ "$IMAGE_TAG" = "local" ] && echo "true" || echo "false")
59+
IS_LOCAL_HELM=$([ "$HELM_CHART_VERSION" = "local" ] && echo "true" || echo "false")
5960

6061
# TODO: Handle both in the e2e tests
6162
ISSUER_TYPE="Issuer"
@@ -179,7 +180,7 @@ install_cert_manager_issuer() {
179180
echo "📦 Installing instance of $IMAGE_NAME with tag $IMAGE_TAG..."
180181

181182

182-
if [[ "$HELM_CHART_VERSION" == "local" ]]; then
183+
if [[ "$IS_LOCAL_HELM" == "true" ]]; then
183184
CHART_PATH=$CHART_PATH
184185

185186
# Checking if chart path exists
@@ -431,6 +432,12 @@ check_env
431432
cd ..
432433

433434
echo "⚙️ Local image deployment: ${IS_LOCAL_DEPLOYMENT}"
435+
echo "⚙️ Local Helm chart: ${IS_LOCAL_HELM}"
436+
437+
if ! minikube status &> /dev/null; then
438+
echo "Error: Minikube is not running. Please start it with 'minikube start'"
439+
exit 1
440+
fi
434441

435442
kubectl config use-context minikube
436443
echo "Connected to Kubernetes context: $(kubectl config current-context)..."

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ go 1.23.4
44

55
require (
66
github.com/Keyfactor/keyfactor-auth-client-go v1.2.0
7-
github.com/Keyfactor/keyfactor-go-client-sdk/v25 v25.0.0-rc.5
7+
github.com/Keyfactor/keyfactor-go-client-sdk/v25 v25.0.0
88
github.com/cert-manager/cert-manager v1.16.2
99
github.com/go-logr/logr v1.4.2
1010
github.com/stretchr/testify v1.10.0

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ github.com/AzureAD/microsoft-authentication-library-for-go v1.3.2 h1:kYRSnvJju5g
2424
github.com/AzureAD/microsoft-authentication-library-for-go v1.3.2/go.mod h1:wP83P5OoQ5p6ip3ScPr0BAq0BvuPAvacpEuSzyouqAI=
2525
github.com/Keyfactor/keyfactor-auth-client-go v1.2.0 h1:uNSlyOW5Bqpi0nsOGZtOYQzN0vP/h4S4J38jtQes+OI=
2626
github.com/Keyfactor/keyfactor-auth-client-go v1.2.0/go.mod h1:7htRcBIWn+X4fI5jaYBALSYwP84H/djN7d8y3n0ZDQ0=
27-
github.com/Keyfactor/keyfactor-go-client-sdk/v25 v25.0.0-rc.5 h1:KiCdQssR8TgbAY5gnb8ShcjMbuzf5y+95BdLqVifReI=
28-
github.com/Keyfactor/keyfactor-go-client-sdk/v25 v25.0.0-rc.5/go.mod h1:tAg67Y6koUoVYSYeWelq25si5Dr21UDVTNAFi1pJoWY=
27+
github.com/Keyfactor/keyfactor-go-client-sdk/v25 v25.0.0 h1:lz+0F3d7nGQORK9VOcQFEvhf7OKhhho6o0idPxh2gvM=
28+
github.com/Keyfactor/keyfactor-go-client-sdk/v25 v25.0.0/go.mod h1:tAg67Y6koUoVYSYeWelq25si5Dr21UDVTNAFi1pJoWY=
2929
github.com/alexbrainman/sspi v0.0.0-20231016080023-1a75b4708caa h1:LHTHcTQiSGT7VVbI0o4wBRNQIgn917usHWOd6VAffYI=
3030
github.com/alexbrainman/sspi v0.0.0-20231016080023-1a75b4708caa/go.mod h1:cEWa1LVoE5KvSD9ONXsZrj0z6KqySlCCNKHlLzbqAt4=
3131
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=

0 commit comments

Comments
 (0)