Fix silly "runner remove" logic error (#184)

* make trace work for github auth and pat token request
* fix don't retry session creation after removal, since error message changed

Author: ChristopherHX

.github/workflows/build.yml

@@ -262,6 +262,12 @@ jobs:
         # Show debug logs of loglevel test
         ./actions-runner/Runner.Client --server http://localhost:5000 -W ./.github/testworkflows/loglevel.yml --log-output-dir ./logs -s ACTIONS_STEP_DEBUG=true
 
+    - name: Test if removal works
+      timeout-minutes: 1
+      run: |
+        export JIT_TOKEN="$(./runner/github-act-runner configure --unattended --url http://localhost:5000/runner/test --token WhichToken --print-jitconfig)"
+        ./runner/github-act-runner remove --jitconfig "$JIT_TOKEN" --token WhichToken
+        ./runner/github-act-runner run --jitconfig "$JIT_TOKEN" && exit 1 || [[ "$?" = "1" ]]
     - name: Archive Test Results
       if: ${{always()}}
       run: tar czf ../logs.tar.gz .

actionsrunner/runner.go

@@ -248,8 +248,8 @@ func (run *RunRunner) Run(runnerenv RunnerEnvironment, listenerctx context.Conte
 							deleteSession()
 							session2, err := vssConnection.CreateSession(joblisteningctx)
 							if err != nil {
-								if strings.Contains(err.Error(), "invalid_client") || strings.Contains(err.Error(), "TaskAgentNotFoundException") {
-									runnerenv.Printf("Fatal: It seems this runner was removed from GitHub, Failed to recreate Session for %v ( %v ): %v\n", instance.Agent.Name, instance.RegistrationURL, err.Error())
+								if strings.Contains(err.Error(), "invalid_client") || strings.Contains(err.Error(), "invalid_grant") || strings.Contains(err.Error(), "TaskAgentNotFoundException") || /* runner.server only */ strings.Contains(err.Error(), "Not Found") {
+									runnerenv.Printf("Fatal: It looks like this runner has been removed from GitHub, Failed to recreate Session for %v ( %v ): %v\n", instance.Agent.Name, instance.RegistrationURL, err.Error())
 									return 1
 								}
 								runnerenv.Printf("Failed to recreate Session for %v ( %v ), waiting 30 sec before retry: %v\n", instance.Agent.Name, instance.RegistrationURL, err.Error())

main.go

@@ -306,7 +306,7 @@ func main() {
 			remove.ReadFromEnvironment()
 			var settings *runnerconfiguration.RunnerSettings
 			var err error
-			if local {
+			if !local {
 				if jitConfig != "" {
 					if settings, err = runnerCompat.ParseJitRunnerConfig(jitConfig); err != nil {
 						fmt.Printf("jitconfig is corrupted: %v, please reconfigure the runner\n", err.Error())
@@ -349,7 +349,7 @@ func main() {
 	cmdRemove.Flags().StringVar(&remove.Name, "name", "", "name of the runner to remove")
 	cmdRemove.Flags().BoolVar(&remove.Trace, "trace", false, "trace http communication with the github action service")
 	cmdRemove.Flags().BoolVar(&remove.Force, "force", false, "force remove the instance even if the service responds with an error")
-	cmdRemove.Flags().StringVarP(&jitConfig, "jitconfig", "", os.Getenv("ACTIONS_RUNNER_INPUT_JITCONFIG"), "read the runner configuration from the jitconfig")
+	cmdRemove.Flags().StringVarP(&jitConfig, "jitconfig", "", os.Getenv("ACTIONS_RUNNER_INPUT_JITCONFIG"), "read the runner configuration from the jitconfig, this doesn't replace token/pat")
 	cmdRemove.Flags().BoolVar(&local, "local", local, "only delete the configuration")
 
 	var cmdWorker = &cobra.Command{

protocol/connection.go

@@ -25,6 +25,7 @@ type VssConnection struct {
 	TenantURL      string
 	connectionData *ConnectionData
 	Token          string
+	AuthHeader     string
 	PoolID         int64
 	TaskAgent      *TaskAgent
 	Key            *rsa.PrivateKey
@@ -230,6 +231,8 @@ func (vssConnection *VssConnection) requestWithContextNoAuth(ctx context.Context
 	}
 	if len(vssConnection.Token) > 0 {
 		header["Authorization"] = []string{"bearer " + vssConnection.Token}
+	} else if len(vssConnection.AuthHeader) > 0 {
+		header["Authorization"] = []string{vssConnection.AuthHeader}
 	}
 	if vssConnection.Trace {
 		fmt.Printf("Http %v Request started %v\nHeaders:\n%v\nBody: `%v`\n", method, requesturl, getHeadersAsString(request.Header), getBodyAsString(buf))
@@ -264,7 +267,7 @@ func (vssConnection *VssConnection) requestWithContextNoAuth(ctx context.Context
 	if failed {
 		return response.StatusCode, fmt.Errorf("http failure: %v", traceMessage)
 	}
-	if response.StatusCode != 200 && responseBody != nil {
+	if response.StatusCode == 204 && responseBody != nil {
 		return response.StatusCode, io.EOF
 	}
 	return response.StatusCode, setResponseBody(responseReader, responseBody)

runnerconfiguration/common.go

@@ -2,13 +2,13 @@ package runnerconfiguration
 
 import (
 	"bytes"
+	"context"
 	"crypto/rsa"
 	"crypto/tls"
 	"crypto/x509"
 	"encoding/base64"
 	"encoding/json"
 	"fmt"
-	"io/ioutil"
 	"net/http"
 	"net/url"
 	"os"
@@ -96,9 +96,15 @@ type RunnerSettings struct {
 }
 
 func gitHubAuth(config *ConfigureRemoveRunner, c *http.Client, runnerEvent string, apiEndpoint string, survey Survey) (*protocol.GitHubAuthResult, error) {
+	if config.URL == "" {
+		config.URL = survey.GetInput("Which GitHub Url is assosiated with this runner (Normally this isn't missing):", "")
+	}
 	registerUrl, err := url.Parse(config.URL)
 	if err != nil {
-		return nil, fmt.Errorf("invalid Url: %v\n", config.URL)
+		return nil, fmt.Errorf("invalid Url: %v", config.URL)
+	}
+	if registerUrl.Hostname() == "" {
+		return nil, fmt.Errorf("invalid Url missing Hostname: %v", config.URL)
 	}
 	apiscope := "/"
 	if strings.ToLower(registerUrl.Host) == "github.com" {
@@ -122,22 +128,15 @@ func gitHubAuth(config *ConfigureRemoveRunner, c *http.Client, runnerEvent strin
 			} else {
 				return nil, fmt.Errorf("unsupported registration url")
 			}
-			req, _ := http.NewRequest("POST", url.String(), nil)
-			req.SetBasicAuth("github", config.Pat)
-			req.Header.Add("Accept", "application/vnd.github.v3+json")
-			resp, err := c.Do(req)
-			if err != nil {
-				return nil, fmt.Errorf("failed to retrieve %v token via pat: %v\n", apiEndpoint, err.Error())
-			}
-			defer resp.Body.Close()
-			if resp.StatusCode < 200 || resp.StatusCode >= 300 {
-				body, _ := ioutil.ReadAll(resp.Body)
-				return nil, fmt.Errorf("failed to retrieve %v via pat [%v]: %v\n", apiEndpoint, fmt.Sprint(resp.StatusCode), string(body))
+			client := &protocol.VssConnection{
+				AuthHeader: fmt.Sprintf("Basic %v", base64.StdEncoding.EncodeToString([]byte("GitHub:"+config.Pat))),
+				Trace:      config.Trace,
+				Client:     c,
 			}
 			tokenresp := &protocol.GitHubRunnerRegisterToken{}
-			dec := json.NewDecoder(resp.Body)
-			if err := dec.Decode(tokenresp); err != nil {
-				return nil, fmt.Errorf("failed to decode registration token via pat: " + err.Error())
+			err = client.RequestWithContext2(context.Background(), "POST", url.String(), "", nil, tokenresp)
+			if err != nil {
+				return nil, fmt.Errorf("failed to retrieve %v token via pat: %v", apiEndpoint, err.Error())
 			}
 			config.Token = tokenresp.Token
 		} else if !config.Unattended {
@@ -159,21 +158,16 @@ func gitHubAuth(config *ConfigureRemoveRunner, c *http.Client, runnerEvent strin
 	}
 	finalregisterUrl := registerUrl.String()
 
-	r, _ := http.NewRequest("POST", finalregisterUrl, buf)
-	r.Header["Authorization"] = []string{"RemoteAuth " + config.Token}
-	resp, err := c.Do(r)
-	if err != nil {
-		return nil, fmt.Errorf("failed to register Runner: %v\n", err)
+	client := &protocol.VssConnection{
+		AuthHeader: "RemoteAuth " + config.Token,
+		Trace:      config.Trace,
+		Client:     c,
 	}
-	defer resp.Body.Close()
-	if resp.StatusCode != 200 {
-		return nil, fmt.Errorf("failed to register Runner with status code: %v\n", resp.StatusCode)
-	}
-
 	res := &protocol.GitHubAuthResult{}
-	dec := json.NewDecoder(resp.Body)
-	if err := dec.Decode(res); err != nil {
-		return nil, fmt.Errorf("error decoding struct from JSON: %v\n", err)
+	err = client.RequestWithContext2(context.Background(), "POST", finalregisterUrl, "", buf, res)
+
+	if err != nil {
+		return nil, fmt.Errorf("failed to authenticate as Runner Admin: %v", err)
 	}
 	return res, nil
 }
@@ -189,6 +183,7 @@ func (config *RemoveRunner) Authenticate(c *http.Client, survey Survey) (*protoc
 func (config *ConfigureRunner) Authenicate(c *http.Client, survey Survey) (*protocol.GitHubAuthResult, error) {
 	return config.Authenticate(c, survey)
 }
+
 // Deprecated: Use the Authenticate method.
 func (config *RemoveRunner) Authenicate(c *http.Client, survey Survey) (*protocol.GitHubAuthResult, error) {
 	return config.Authenticate(c, survey)