fix: CRs

Signed-off-by: Matthias Riegler <[email protected]>

Author: xvzf

Readme.md

@@ -7,7 +7,7 @@
 The LeaseProvider is a server that provides the ability to manage distributed leases among multiple github action runs, letting the highest priority run _win_ the lease. This process is helpful when there are multiple runs running that need access to a shared resource. It allows them to agree on the _winner_ of a race for the resource, and subsequently provide the _winner_ with a lease until it is released.
 Depending on the release status (success/failure), the lease is completed and confirmation is awaited or the request from the failing lease is discarded and the process restarts.
 
-It exposes two endpoints:
+It exposes the following endpoints:
 - GET `/healthz` Kubernetes health endpoint
 - GET `/readyz` Kubernetes readiness endpoint
 - GET `/metrics` Prometheus metric endpoint

internal/github/types.go

@@ -145,7 +145,7 @@ func (lp *leaseProviderImpl) insert(leaseRequest *LeaseRequest) (*LeaseRequest,
 	return lp.known[leaseRequest.HeadSHA], nil
 }
 
-func (lp *leaseProviderImpl) isWinningLeaseRequest(req *LeaseRequest) *LeaseRequest {
+func (lp *leaseProviderImpl) evaluateRequest(req *LeaseRequest) *LeaseRequest {
 	// Prereq: we can expect the arg to be already part of the map!
 
 	if lp.aquired != nil && !(pointer.StringDeref(lp.aquired.Status, STATUS_AQUIRED) == STATUS_FAILURE) {
@@ -197,7 +197,7 @@ func (lp *leaseProviderImpl) Aquire(leaseRequest *LeaseRequest) (*LeaseRequest,
 	}
 
 	// Return the request object with the correct status
-	return lp.isWinningLeaseRequest(req), nil
+	return lp.evaluateRequest(req), nil
 }
 
 func (lp *leaseProviderImpl) Release(leaseRequest *LeaseRequest) (*LeaseRequest, error) {

internal/lease/leaseprovider.go

@@ -213,7 +213,7 @@ func Test_leaseProviderImpl_evictTTL_aquired(t *testing.T) {
 	assert.Equal(t, 1, len(lpImpl.known))
 }
 
-func Test_leaseProviderImpl_isWinningLeaseRequest_timePassed(t *testing.T) {
+func Test_leaseProviderImpl_evaluateRequest_timePassed(t *testing.T) {
 	lp := NewLeaseProvider(&LeaseProviderOpts{TTL: 1 * time.Hour, StabilizeDuration: 1 * time.Minute, ExpectedRequestCount: 4})
 	lpImpl, ok := lp.(*leaseProviderImpl)
 	assert.True(t, ok)
@@ -235,16 +235,16 @@ func Test_leaseProviderImpl_isWinningLeaseRequest_timePassed(t *testing.T) {
 	assert.NoError(t, err)
 
 	// Immediately check if req2 gets the lease (it should not!)
-	_ = lpImpl.isWinningLeaseRequest(req2)
+	_ = lpImpl.evaluateRequest(req2)
 	assert.Equal(t, *req2.Status, STATUS_PENDING)
 
 	// Simulate a time passed by setting the last updated timestamp in the past
 	lpImpl.lastUpdatedAt = time.Now().Add(-2 * time.Minute)
-	_ = lpImpl.isWinningLeaseRequest(req2)
+	_ = lpImpl.evaluateRequest(req2)
 	assert.Equal(t, *req2.Status, STATUS_AQUIRED)
 }
 
-func Test_leaseProviderImpl_isWinningLeaseRequest_reachedExpectedRequestCount(t *testing.T) {
+func Test_leaseProviderImpl_evaluateRequest_reachedExpectedRequestCount(t *testing.T) {
 	lp := NewLeaseProvider(&LeaseProviderOpts{TTL: 1 * time.Hour, StabilizeDuration: 1 * time.Minute, ExpectedRequestCount: 3})
 	lpImpl, ok := lp.(*leaseProviderImpl)
 	assert.True(t, ok)
@@ -269,17 +269,17 @@ func Test_leaseProviderImpl_isWinningLeaseRequest_reachedExpectedRequestCount(t
 	assert.NoError(t, err)
 
 	// Immediately check if req2 gets the lease (it should not!)
-	_ = lpImpl.isWinningLeaseRequest(req2)
+	_ = lpImpl.evaluateRequest(req2)
 	assert.Equal(t, *req2.Status, STATUS_PENDING)
 
 	// Add 3rd request, making it complete (it has a lower priority compared to req2)
 	_, err = lpImpl.insert(req3)
 	assert.NoError(t, err)
-	_ = lpImpl.isWinningLeaseRequest(req2)
+	_ = lpImpl.evaluateRequest(req2)
 	assert.Equal(t, *req2.Status, STATUS_AQUIRED)
 }
 
-func Test_leaseProviderImpl_isWinningLeaseRequest_errorNoLeaseAssigned(t *testing.T) {
+func Test_leaseProviderImpl_evaluateRequest_errorNoLeaseAssigned(t *testing.T) {
 	lp := NewLeaseProvider(&LeaseProviderOpts{TTL: 1 * time.Hour, StabilizeDuration: 1 * time.Minute, ExpectedRequestCount: 3})
 	lpImpl, ok := lp.(*leaseProviderImpl)
 	assert.True(t, ok)
@@ -305,7 +305,7 @@ func Test_leaseProviderImpl_isWinningLeaseRequest_errorNoLeaseAssigned(t *testin
 	lpImpl.aquired = req2
 
 	// Make sure there's no status modification when checking if a lease is the winner
-	req1copy := lpImpl.isWinningLeaseRequest(&LeaseRequest{
+	req1copy := lpImpl.evaluateRequest(&LeaseRequest{
 		HeadSHA:  req1.HeadSHA,
 		Priority: req1.Priority,
 		Status:   pointer.String(STATUS_PENDING),