-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathinit.go
More file actions
449 lines (375 loc) · 12.6 KB
/
init.go
File metadata and controls
449 lines (375 loc) · 12.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
package cmd
import (
"codacy/cli-v2/config"
"codacy/cli-v2/tools"
"codacy/cli-v2/utils"
"encoding/json"
"errors"
"fmt"
"io"
"log"
"net/http"
"os"
"path/filepath"
"time"
"github.com/spf13/cobra"
)
const CodacyApiBase = "https://app.codacy.com"
var codacyRepositoryToken string
func init() {
initCmd.Flags().StringVar(&codacyRepositoryToken, "repository-token", "", "optional codacy repository token, if defined configurations will be fetched from codacy")
rootCmd.AddCommand(initCmd)
}
var initCmd = &cobra.Command{
Use: "init",
Short: "Bootstraps project configuration",
Long: "Bootstraps project configuration, creates codacy configuration file",
Run: func(cmd *cobra.Command, args []string) {
config.Config.CreateLocalCodacyDir()
cliLocalMode := len(codacyRepositoryToken) == 0
if cliLocalMode {
fmt.Println()
fmt.Println("ℹ️ No project token was specified, skipping fetch configurations")
noTools := []tools.Tool{}
err := createConfigurationFiles(noTools, cliLocalMode)
if err != nil {
log.Fatal(err)
}
} else {
apiTools, err := tools.GetTools()
if err != nil {
log.Fatal(err)
}
err = createConfigurationFiles(apiTools, cliLocalMode)
if err != nil {
log.Fatal(err)
}
err = buildRepositoryConfigurationFiles(codacyRepositoryToken)
if err != nil {
log.Fatal(err)
}
createGitIgnoreFile()
}
fmt.Println()
fmt.Println("✅ Successfully initialized Codacy configuration!")
fmt.Println()
fmt.Println("🔧 Next steps:")
fmt.Println(" 1. Run 'codacy-cli install' to install all dependencies")
fmt.Println(" 2. Run 'codacy-cli analyze' to start analyzing your code")
fmt.Println()
},
}
func createGitIgnoreFile() error {
gitIgnorePath := filepath.Join(config.Config.LocalCodacyDirectory(), ".gitignore")
gitIgnoreFile, err := os.Create(gitIgnorePath)
if err != nil {
return fmt.Errorf("failed to create .gitignore file: %w", err)
}
defer gitIgnoreFile.Close()
content := `# Codacy CLI
tools-configs/
.gitignore
cli-config.yaml
`
if _, err := gitIgnoreFile.WriteString(content); err != nil {
return fmt.Errorf("failed to write to .gitignore file: %w", err)
}
return nil
}
func createConfigurationFiles(tools []tools.Tool, cliLocalMode bool) error {
configFile, err := os.Create(config.Config.ProjectConfigFile())
defer configFile.Close()
if err != nil {
log.Fatal(err)
}
_, err = configFile.WriteString(configFileTemplate(tools))
if err != nil {
log.Fatal(err)
}
cliConfigFile, err := os.Create(config.Config.CliConfigFile())
defer cliConfigFile.Close()
if err != nil {
log.Fatal(err)
}
_, err = cliConfigFile.WriteString(cliConfigFileTemplate(cliLocalMode))
if err != nil {
log.Fatal(err)
}
return nil
}
func configFileTemplate(tools []tools.Tool) string {
// Default versions
eslintVersion := "9.3.0"
trivyVersion := "0.59.1" // Latest stable version
pylintVersion := "3.3.6"
pmdVersion := "6.55.0"
for _, tool := range tools {
if tool.Uuid == "f8b29663-2cb2-498d-b923-a10c6a8c05cd" {
eslintVersion = tool.Version
}
if tool.Uuid == "2fd7fbe0-33f9-4ab3-ab73-e9b62404e2cb" {
trivyVersion = tool.Version
}
if tool.Uuid == "31677b6d-4ae0-4f56-8041-606a8d7a8e61" {
pylintVersion = tool.Version
}
if tool.Uuid == "9ed24812-b6ee-4a58-9004-0ed183c45b8f" {
pmdVersion = tool.Version
}
}
return fmt.Sprintf(`runtimes:
- node@22.2.0
- python@3.11.11
tools:
- eslint@%s
- trivy@%s
- pylint@%s
- pmd@%s
`, eslintVersion, trivyVersion, pylintVersion, pmdVersion)
}
func cliConfigFileTemplate(cliLocalMode bool) string {
var cliModeString string
if cliLocalMode {
cliModeString = "local"
} else {
cliModeString = "remote"
}
return fmt.Sprintf(`mode: %s`, cliModeString)
}
func buildRepositoryConfigurationFiles(token string) error {
fmt.Println("Building repository configuration files ...")
fmt.Println("Fetching repository configuration from codacy ...")
toolsConfigDir := config.Config.ToolsConfigDirectory()
// Create tools-configs directory if it doesn't exist
if err := os.MkdirAll(toolsConfigDir, utils.DefaultDirPerms); err != nil {
return fmt.Errorf("failed to create tools-configs directory: %w", err)
}
// API call to fetch settings
url := CodacyApiBase + "/2.0/project/analysis/configuration"
client := &http.Client{
Timeout: 10 * time.Second,
}
// Create a new GET request
req, err := http.NewRequest("GET", url, nil)
if err != nil {
fmt.Println("Error:", err)
return err
}
// Set the headers
req.Header.Set("project-token", token)
// Send the request
resp, err := client.Do(req)
if err != nil {
fmt.Println("Error:", err)
return err
}
defer resp.Body.Close()
if resp.StatusCode >= 400 {
return errors.New("failed to get repository's configuration from Codacy API")
}
// Read the response body
body, err := io.ReadAll(resp.Body)
if err != nil {
fmt.Println("Error:", err)
return err
}
var objmap map[string]json.RawMessage
err = json.Unmarshal(body, &objmap)
if err != nil {
fmt.Println("Error unmarshaling response:", err)
return err
}
var apiToolConfigurations []CodacyToolConfiguration
err = json.Unmarshal(objmap["toolConfiguration"], &apiToolConfigurations)
if err != nil {
fmt.Println("Error unmarshaling tool configurations:", err)
return err
}
// ESLint configuration
eslintApiConfiguration := extractESLintConfiguration(apiToolConfigurations)
if eslintApiConfiguration != nil {
eslintDomainConfiguration := convertAPIToolConfigurationToDomain(*eslintApiConfiguration)
eslintConfigurationString := tools.CreateEslintConfig(eslintDomainConfiguration)
eslintConfigFile, err := os.Create(filepath.Join(toolsConfigDir, "eslint.config.mjs"))
if err != nil {
return fmt.Errorf("failed to create eslint config file: %v", err)
}
defer eslintConfigFile.Close()
_, err = eslintConfigFile.WriteString(eslintConfigurationString)
if err != nil {
return fmt.Errorf("failed to write eslint config: %v", err)
}
fmt.Println("ESLint configuration created based on Codacy settings")
} else {
err = createDefaultEslintConfigFile(toolsConfigDir)
if err != nil {
return fmt.Errorf("failed to create default ESLint config: %v", err)
}
fmt.Println("Default ESLint configuration created")
}
// Trivy configuration
trivyApiConfiguration := extractTrivyConfiguration(apiToolConfigurations)
if trivyApiConfiguration != nil {
err = createTrivyConfigFile(*trivyApiConfiguration, toolsConfigDir)
if err != nil {
return fmt.Errorf("failed to create Trivy config: %v", err)
}
fmt.Println("Trivy configuration created based on Codacy settings")
} else {
err = createDefaultTrivyConfigFile(toolsConfigDir)
if err != nil {
return fmt.Errorf("failed to create default Trivy config: %v", err)
}
fmt.Println("Default Trivy configuration created")
}
// PMD configuration
pmdApiConfiguration := extractPMDConfiguration(apiToolConfigurations)
if pmdApiConfiguration != nil {
err = createPMDConfigFile(*pmdApiConfiguration, toolsConfigDir)
if err != nil {
return fmt.Errorf("failed to create PMD config: %v", err)
}
fmt.Println("PMD configuration created based on Codacy settings")
} else {
err = createDefaultPMDConfigFile(toolsConfigDir)
if err != nil {
return fmt.Errorf("failed to create default PMD config: %v", err)
}
fmt.Println("Default PMD configuration created")
}
return nil
}
func convertAPIToolConfigurationToDomain(config CodacyToolConfiguration) tools.ToolConfiguration {
var patterns []tools.PatternConfiguration
for _, pattern := range config.Patterns {
var parameters []tools.PatternParameterConfiguration
for _, parameter := range pattern.Parameters {
parameters = append(parameters, tools.PatternParameterConfiguration{
Name: parameter.Name,
Value: parameter.Value,
})
}
patterns = append(
patterns,
tools.PatternConfiguration{
PatternId: pattern.InternalId,
ParameterConfigurations: parameters,
},
)
}
return tools.ToolConfiguration{
PatternsConfiguration: patterns,
}
}
func extractESLintConfiguration(toolConfigurations []CodacyToolConfiguration) *CodacyToolConfiguration {
//ESLInt internal codacy uuid, to filter ot not ESLint tools
//"f8b29663-2cb2-498d-b923-a10c6a8c05cd"
for _, toolConfiguration := range toolConfigurations {
if toolConfiguration.Uuid == "f8b29663-2cb2-498d-b923-a10c6a8c05cd" {
return &toolConfiguration
}
}
return nil
}
// extractTrivyConfiguration extracts Trivy configuration from the Codacy API response
func extractTrivyConfiguration(toolConfigurations []CodacyToolConfiguration) *CodacyToolConfiguration {
// Trivy internal codacy uuid
const TrivyUUID = "2fd7fbe0-33f9-4ab3-ab73-e9b62404e2cb"
for _, toolConfiguration := range toolConfigurations {
if toolConfiguration.Uuid == TrivyUUID {
return &toolConfiguration
}
}
return nil
}
// Add PMD-specific functions
func extractPMDConfiguration(toolConfigurations []CodacyToolConfiguration) *CodacyToolConfiguration {
const PMDUUID = "9ed24812-b6ee-4a58-9004-0ed183c45b8f"
for _, toolConfiguration := range toolConfigurations {
if toolConfiguration.Uuid == PMDUUID {
return &toolConfiguration
}
}
return nil
}
func createPMDConfigFile(config CodacyToolConfiguration, toolsConfigDir string) error {
pmdDomainConfiguration := convertAPIToolConfigurationToDomain(config)
pmdConfigurationString := tools.CreatePmdConfig(pmdDomainConfiguration)
return os.WriteFile(filepath.Join(toolsConfigDir, "pmd-ruleset.xml"), []byte(pmdConfigurationString), utils.DefaultRW)
}
func createDefaultPMDConfigFile(toolsConfigDir string) error {
emptyConfig := tools.ToolConfiguration{}
content := tools.CreatePmdConfig(emptyConfig)
return os.WriteFile(filepath.Join(toolsConfigDir, "pmd-ruleset.xml"), []byte(content), utils.DefaultRW)
}
type CodacyToolConfiguration struct {
Uuid string `json:"uuid"`
IsEnabled bool `json:"isEnabled"`
Patterns []PatternConfiguration `json:"patterns"`
}
type PatternConfiguration struct {
InternalId string `json:"internalId"`
Parameters []ParameterConfiguration `json:"parameters"`
}
type ParameterConfiguration struct {
Name string `json:"name"`
Value string `json:"value"`
}
// createTrivyConfigFile creates a trivy.yaml configuration file based on the API configuration
func createTrivyConfigFile(config CodacyToolConfiguration, toolsConfigDir string) error {
// Convert CodacyToolConfiguration to tools.ToolConfiguration
trivyDomainConfiguration := convertAPIToolConfigurationForTrivy(config)
// Use the shared CreateTrivyConfig function to generate the config content
trivyConfigurationString := tools.CreateTrivyConfig(trivyDomainConfiguration)
// Write to file
return os.WriteFile(filepath.Join(toolsConfigDir, "trivy.yaml"), []byte(trivyConfigurationString), utils.DefaultRW)
}
// convertAPIToolConfigurationForTrivy converts API tool configuration to domain model for Trivy
func convertAPIToolConfigurationForTrivy(config CodacyToolConfiguration) tools.ToolConfiguration {
var patterns []tools.PatternConfiguration
// Only process if tool is enabled
if config.IsEnabled {
for _, pattern := range config.Patterns {
var parameters []tools.PatternParameterConfiguration
// By default patterns are enabled
patternEnabled := true
// Check if there's an explicit enabled parameter
for _, param := range pattern.Parameters {
if param.Name == "enabled" && param.Value == "false" {
patternEnabled = false
}
}
// Add enabled parameter
parameters = append(parameters, tools.PatternParameterConfiguration{
Name: "enabled",
Value: fmt.Sprintf("%t", patternEnabled),
})
patterns = append(
patterns,
tools.PatternConfiguration{
PatternId: pattern.InternalId,
ParameterConfigurations: parameters,
},
)
}
}
return tools.ToolConfiguration{
PatternsConfiguration: patterns,
}
}
// createDefaultTrivyConfigFile creates a default trivy.yaml configuration file
func createDefaultTrivyConfigFile(toolsConfigDir string) error {
// Use empty tool configuration to get default settings
emptyConfig := tools.ToolConfiguration{}
content := tools.CreateTrivyConfig(emptyConfig)
// Write to file
return os.WriteFile(filepath.Join(toolsConfigDir, "trivy.yaml"), []byte(content), utils.DefaultRW)
}
// createDefaultEslintConfigFile creates a default eslint.config.mjs configuration file
func createDefaultEslintConfigFile(toolsConfigDir string) error {
// Use empty tool configuration to get default settings
emptyConfig := tools.ToolConfiguration{}
content := tools.CreateEslintConfig(emptyConfig)
// Write to file
return os.WriteFile(filepath.Join(toolsConfigDir, "eslint.config.mjs"), []byte(content), utils.DefaultRW)
}