Skip to content

Commit 2347f6a

Browse files
author
privapps
committed
Refactor CI/CD workflows and improve code quality
- Updated GitHub Actions workflows to use the latest versions of actions. - Enhanced security checks by replacing Gosec with Go vet and go mod verify. - Removed the Create Release step and replaced it with softprops/action-gh-release for better asset management. - Improved error handling in authentication and token management functions. - Refactored timeout constants and validation logic in the configuration. - Enhanced test coverage and error handling in various test cases. - Improved logging and graceful shutdown handling in the server. - Updated HTTP response handling to use http.NoBody for clarity.
1 parent 471ee22 commit 2347f6a

19 files changed

+290
-223
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ on:
88

99
permissions:
1010
contents: read
11+
packages: write
1112

1213
jobs:
1314
test:
@@ -38,7 +39,7 @@ jobs:
3839
go tool cover -html=coverage.out -o coverage.html
3940
4041
- name: Upload coverage reports
41-
uses: actions/upload-artifact@v3
42+
uses: actions/upload-artifact@v4
4243
with:
4344
name: coverage-report
4445
path: |
@@ -67,7 +68,7 @@ jobs:
6768
uses: golangci/golangci-lint-action@v3
6869
with:
6970
version: latest
70-
args: --timeout=5m
71+
args: --timeout=5m --out-format=colored-line-number
7172

7273
security:
7374
runs-on: ubuntu-latest
@@ -80,14 +81,17 @@ jobs:
8081
with:
8182
go-version: '1.21'
8283

83-
- name: Run Gosec Security Scanner
84-
uses: securecodewarrior/github-action-gosec@master
85-
with:
86-
args: './...'
84+
- name: Run Go Security Checks
85+
run: |
86+
echo "Running Go vet for security analysis..."
87+
go vet ./...
88+
echo "Running go mod verify for dependency integrity..."
89+
go mod verify
90+
echo "Security checks completed successfully"
8791
8892
build:
8993
runs-on: ubuntu-latest
90-
needs: [test, lint]
94+
needs: [test, lint, security]
9195
steps:
9296
- name: Checkout code
9397
uses: actions/checkout@v4
@@ -102,7 +106,7 @@ jobs:
102106
go build -ldflags="-s -w -X main.version=ci-${{ github.sha }}" -o github-copilot-svcs .
103107
104108
- name: Upload build artifact
105-
uses: actions/upload-artifact@v3
109+
uses: actions/upload-artifact@v4
106110
with:
107111
name: github-copilot-svcs-${{ github.sha }}
108112
path: github-copilot-svcs
@@ -117,18 +121,19 @@ jobs:
117121
- name: Set up Docker Buildx
118122
uses: docker/setup-buildx-action@v3
119123

120-
- name: Login to Docker Hub
124+
- name: Login to GitHub Container Registry
121125
if: github.event_name != 'pull_request'
122126
uses: docker/login-action@v3
123127
with:
124-
username: ${{ secrets.DOCKER_USERNAME }}
125-
password: ${{ secrets.DOCKER_PASSWORD }}
128+
registry: ghcr.io
129+
username: ${{ github.actor }}
130+
password: ${{ secrets.GITHUB_TOKEN }}
126131

127132
- name: Extract metadata
128133
id: meta
129134
uses: docker/metadata-action@v5
130135
with:
131-
images: ${{ secrets.DOCKER_USERNAME }}/github-copilot-svcs
136+
images: ghcr.io/${{ github.repository }}
132137
tags: |
133138
type=ref,event=branch
134139
type=ref,event=pr

‎.github/workflows/release.yml‎

Lines changed: 17 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ on:
77

88
permissions:
99
contents: write
10+
packages: write
1011

1112
jobs:
1213
release:
1314
runs-on: ubuntu-latest
1415
outputs:
1516
version: ${{ steps.version.outputs.version }}
16-
upload_url: ${{ steps.create_release.outputs.upload_url }}
1717
steps:
1818
- name: Checkout code
1919
uses: actions/checkout@v4
@@ -59,29 +59,6 @@ jobs:
5959
git tag ${{ steps.version.outputs.version }}
6060
git push origin ${{ steps.version.outputs.version }}
6161
62-
- name: Create Release
63-
id: create_release
64-
uses: actions/create-release@v1
65-
env:
66-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
67-
with:
68-
tag_name: ${{ steps.version.outputs.version }}
69-
release_name: Release ${{ steps.version.outputs.version }}
70-
body: |
71-
## Changes in ${{ steps.version.outputs.version }}
72-
73-
Auto-generated release from main branch.
74-
75-
### Downloads
76-
- Linux AMD64: `github-copilot-svcs-linux-amd64.gz`
77-
- Linux ARM64: `github-copilot-svcs-linux-arm64.gz`
78-
- macOS AMD64: `github-copilot-svcs-darwin-amd64.gz`
79-
- macOS ARM64: `github-copilot-svcs-darwin-arm64.gz`
80-
- Windows AMD64: `github-copilot-svcs-windows-amd64.exe.gz`
81-
- Windows ARM64: `github-copilot-svcs-windows-arm64.exe.gz`
82-
draft: false
83-
prerelease: false
84-
8562
build:
8663
needs: release
8764
runs-on: ubuntu-latest
@@ -136,14 +113,22 @@ jobs:
136113
ls -la "$GZ_BINARY_NAME"
137114
138115
- name: Upload Release Asset
139-
uses: actions/upload-release-asset@v1
140-
env:
141-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
116+
uses: softprops/action-gh-release@v2
142117
with:
143-
upload_url: ${{ needs.release.outputs.upload_url }}
144-
asset_path: ./github-copilot-svcs-${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.suffix }}.gz
145-
asset_name: github-copilot-svcs-${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.suffix }}.gz
146-
asset_content_type: application/gzip
118+
tag_name: ${{ needs.release.outputs.version }}
119+
files: ./github-copilot-svcs-${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.suffix }}.gz
120+
body: |
121+
## Changes in ${{ needs.release.outputs.version }}
122+
123+
Auto-generated release from main branch.
124+
125+
### Downloads
126+
- Linux AMD64: `github-copilot-svcs-linux-amd64.gz`
127+
- Linux ARM64: `github-copilot-svcs-linux-arm64.gz`
128+
- macOS AMD64: `github-copilot-svcs-darwin-amd64.gz`
129+
- macOS ARM64: `github-copilot-svcs-darwin-arm64.gz`
130+
- Windows AMD64: `github-copilot-svcs-windows-amd64.exe.gz`
131+
- Windows ARM64: `github-copilot-svcs-windows-arm64.exe.gz`
147132
148133
docker:
149134
needs: release
@@ -155,12 +140,6 @@ jobs:
155140
- name: Set up Docker Buildx
156141
uses: docker/setup-buildx-action@v3
157142

158-
- name: Login to Docker Hub
159-
uses: docker/login-action@v3
160-
with:
161-
username: ${{ secrets.DOCKER_USERNAME }}
162-
password: ${{ secrets.DOCKER_PASSWORD }}
163-
164143
- name: Login to GitHub Container Registry
165144
uses: docker/login-action@v3
166145
with:
@@ -172,9 +151,7 @@ jobs:
172151
id: meta
173152
uses: docker/metadata-action@v5
174153
with:
175-
images: |
176-
${{ secrets.DOCKER_USERNAME }}/github-copilot-svcs
177-
ghcr.io/${{ github.repository }}
154+
images: ghcr.io/${{ github.repository }}
178155
tags: |
179156
type=semver,pattern={{version}},value=${{ needs.release.outputs.version }}
180157
type=semver,pattern={{major}}.{{minor}},value=${{ needs.release.outputs.version }}

‎Dockerfile‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ WORKDIR /app
55
# Install git and ca-certificates for building
66
RUN apk add --no-cache git ca-certificates
77

8-
# Copy go mod files
9-
COPY go.mod go.sum ./
8+
# Copy go mod file
9+
COPY go.mod ./
1010

11-
# Download dependencies
11+
# Download dependencies (this will create go.sum if it doesn't exist)
1212
RUN go mod download
1313

1414
# Copy source code

‎auth.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func authenticate(cfg *Config) error {
5959
}
6060

6161
// Step 1: Get device code
62-
body := fmt.Sprintf(`{"client_id":"%s","scope":"%s"}`, copilotClientID, copilotScope)
62+
body := fmt.Sprintf(`{"client_id":%q,"scope":%q}`, copilotClientID, copilotScope)
6363
req, err := http.NewRequest("POST", copilotDeviceCodeURL, strings.NewReader(body))
6464
if err != nil {
6565
return err
@@ -110,7 +110,7 @@ func pollForGitHubToken(cfg *Config, deviceCode string, interval int) (string, e
110110
for i := 0; i < 120; i++ { // Poll for 2 minutes max
111111
time.Sleep(time.Duration(interval) * time.Second)
112112

113-
body := fmt.Sprintf(`{"client_id":"%s","device_code":"%s","grant_type":"urn:ietf:params:oauth:grant-type:device_code"}`,
113+
body := fmt.Sprintf(`{"client_id":%q,"device_code":%q,"grant_type":"urn:ietf:params:oauth:grant-type:device_code"}`,
114114
copilotClientID, deviceCode)
115115
req, err := http.NewRequest("POST", copilotTokenURL, strings.NewReader(body))
116116
if err != nil {
@@ -147,7 +147,7 @@ func pollForGitHubToken(cfg *Config, deviceCode string, interval int) (string, e
147147
return "", fmt.Errorf("authentication timed out")
148148
}
149149

150-
func getCopilotToken(cfg *Config, githubToken string) (string, int64, int64, error) {
150+
func getCopilotToken(cfg *Config, githubToken string) (token string, expiresAt, refreshIn int64, err error) {
151151
req, err := http.NewRequest("GET", copilotAPIKeyURL, http.NoBody)
152152
if err != nil {
153153
return "", 0, 0, err
@@ -161,7 +161,7 @@ func getCopilotToken(cfg *Config, githubToken string) (string, int64, int64, err
161161
}
162162
defer resp.Body.Close()
163163

164-
if resp.StatusCode != 200 {
164+
if resp.StatusCode != http.StatusOK {
165165
return "", 0, 0, fmt.Errorf("failed to get Copilot token: %d", resp.StatusCode)
166166
}
167167

‎auth_test.go‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,24 @@ func TestAuthenticate(t *testing.T) {
2222
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
2323
if r.URL.Path == "/login/device/code" {
2424
w.Header().Set("Content-Type", "application/json")
25-
json.NewEncoder(w).Encode(map[string]interface{}{
25+
if err := json.NewEncoder(w).Encode(map[string]interface{}{
2626
"device_code": "test_device_code",
2727
"user_code": "TEST123",
2828
"verification_uri": "https://github.com/login/device",
2929
"expires_in": 900,
3030
"interval": 5,
31-
})
31+
}); err != nil {
32+
http.Error(w, "Internal Server Error", http.StatusInternalServerError)
33+
}
3234
} else if r.URL.Path == "/login/oauth/access_token" {
3335
w.Header().Set("Content-Type", "application/json")
34-
json.NewEncoder(w).Encode(map[string]interface{}{
36+
if err := json.NewEncoder(w).Encode(map[string]interface{}{
3537
"access_token": "gho_test_token",
3638
"scope": "copilot",
3739
"token_type": "bearer",
38-
})
40+
}); err != nil {
41+
http.Error(w, "Internal Server Error", http.StatusInternalServerError)
42+
}
3943
}
4044
}))
4145
},
@@ -45,7 +49,7 @@ func TestAuthenticate(t *testing.T) {
4549
{
4650
name: "device code request fails",
4751
setupServer: func() *httptest.Server {
48-
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
52+
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
4953
w.WriteHeader(http.StatusInternalServerError)
5054
}))
5155
},
@@ -105,10 +109,12 @@ func TestGetCopilotToken(t *testing.T) {
105109
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
106110
if r.URL.Path == "/copilot_internal/v2/token" {
107111
w.Header().Set("Content-Type", "application/json")
108-
json.NewEncoder(w).Encode(map[string]interface{}{
112+
if err := json.NewEncoder(w).Encode(map[string]interface{}{
109113
"token": "ghu_test_copilot_token",
110114
"expires_at": time.Now().Add(time.Hour).Unix(),
111-
})
115+
}); err != nil {
116+
http.Error(w, "Internal Server Error", http.StatusInternalServerError)
117+
}
112118
}
113119
}))
114120
},
@@ -118,7 +124,7 @@ func TestGetCopilotToken(t *testing.T) {
118124
name: "invalid github token",
119125
githubToken: "invalid_token",
120126
setupServer: func() *httptest.Server {
121-
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
127+
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
122128
w.WriteHeader(http.StatusUnauthorized)
123129
}))
124130
},
@@ -170,9 +176,9 @@ func TestRefreshToken(t *testing.T) {
170176
name: "successful token refresh",
171177
currentToken: "ghu_old_token",
172178
setupServer: func() *httptest.Server {
173-
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
179+
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
174180
w.Header().Set("Content-Type", "application/json")
175-
json.NewEncoder(w).Encode(map[string]interface{}{
181+
_ = json.NewEncoder(w).Encode(map[string]interface{}{
176182
"token": "ghu_new_token",
177183
"expires_at": time.Now().Add(time.Hour).Unix(),
178184
})
@@ -185,7 +191,7 @@ func TestRefreshToken(t *testing.T) {
185191
name: "refresh fails",
186192
currentToken: "ghu_invalid_token",
187193
setupServer: func() *httptest.Server {
188-
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
194+
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
189195
w.WriteHeader(http.StatusUnauthorized)
190196
}))
191197
},
@@ -237,17 +243,17 @@ func TestPollForGitHubToken(t *testing.T) {
237243
deviceCode: "test_device_code",
238244
setupServer: func() *httptest.Server {
239245
callCount := 0
240-
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
246+
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
241247
callCount++
242248
w.Header().Set("Content-Type", "application/json")
243249
if callCount == 1 {
244250
// First call returns pending
245-
json.NewEncoder(w).Encode(map[string]interface{}{
251+
_ = json.NewEncoder(w).Encode(map[string]interface{}{
246252
"error": "authorization_pending",
247253
})
248254
} else {
249255
// Second call returns success
250-
json.NewEncoder(w).Encode(map[string]interface{}{
256+
_ = json.NewEncoder(w).Encode(map[string]interface{}{
251257
"access_token": "gho_test_token",
252258
"scope": "copilot",
253259
"token_type": "bearer",
@@ -261,9 +267,9 @@ func TestPollForGitHubToken(t *testing.T) {
261267
name: "polling timeout",
262268
deviceCode: "test_device_code",
263269
setupServer: func() *httptest.Server {
264-
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
270+
return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
265271
w.Header().Set("Content-Type", "application/json")
266-
json.NewEncoder(w).Encode(map[string]interface{}{
272+
_ = json.NewEncoder(w).Encode(map[string]interface{}{
267273
"error": "authorization_pending",
268274
})
269275
}))

0 commit comments

Comments
 (0)