mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-03 17:44:44 +00:00
* feat(deps): update go version, renovate config, tooling * chore(deps): update google/go-github to v74 * feat(deps): migrate from yaml.v3 to goccy/go-yaml * chore(deps): update goccy/go-yaml to v1.18.0 and address security concerns * feat: improve issue templates and project configuration - Update GitHub issue templates with CLI-specific fields for better bug reports - Add specialized templates for documentation, theme, and performance issues - Update pre-commit config to include comprehensive documentation linting - Remove outdated Snyk configuration and security references - Update Go version from 1.23+ to 1.24+ across project - Streamline README.md organization and improve clarity - Update CHANGELOG.md and CLAUDE.md formatting - Create comprehensive CONTRIBUTING.md with development guidelines - Remove TODO.md (replaced by docs/roadmap.md) - Move SECURITY.md to docs/security.md * docs: fix markdown linting violations across documentation * fix: resolve template placeholder issues and improve uses statement generation * fix: remove trailing whitespace from GitHub issue template
272 lines
7.4 KiB
Go
272 lines
7.4 KiB
Go
package wizard
|
|
|
|
import (
|
|
"encoding/json"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/goccy/go-yaml"
|
|
|
|
"github.com/ivuorinen/gh-action-readme/internal"
|
|
)
|
|
|
|
func TestConfigExporter_ExportConfig(t *testing.T) {
|
|
t.Parallel()
|
|
output := internal.NewColoredOutput(true) // quiet mode for testing
|
|
exporter := NewConfigExporter(output)
|
|
|
|
// Create test config
|
|
config := createTestConfig()
|
|
|
|
// Test YAML export
|
|
t.Run("export YAML", func(t *testing.T) {
|
|
t.Parallel()
|
|
testYAMLExport(exporter, config)(t)
|
|
})
|
|
|
|
// Test JSON export
|
|
t.Run("export JSON", func(t *testing.T) {
|
|
t.Parallel()
|
|
testJSONExport(exporter, config)(t)
|
|
})
|
|
|
|
// Test TOML export
|
|
t.Run("export TOML", func(t *testing.T) {
|
|
t.Parallel()
|
|
testTOMLExport(exporter, config)(t)
|
|
})
|
|
}
|
|
|
|
// createTestConfig creates a test configuration for testing.
|
|
func createTestConfig() *internal.AppConfig {
|
|
return &internal.AppConfig{
|
|
Organization: "testorg",
|
|
Repository: "testrepo",
|
|
Version: "1.0.0",
|
|
Theme: "github",
|
|
OutputFormat: "md",
|
|
OutputDir: ".",
|
|
AnalyzeDependencies: true,
|
|
ShowSecurityInfo: false,
|
|
Variables: map[string]string{"TEST_VAR": "test_value"},
|
|
Permissions: map[string]string{"contents": "read"},
|
|
RunsOn: []string{"ubuntu-latest"},
|
|
}
|
|
}
|
|
|
|
// testYAMLExport tests YAML export functionality.
|
|
func testYAMLExport(exporter *ConfigExporter, config *internal.AppConfig) func(*testing.T) {
|
|
return func(t *testing.T) {
|
|
t.Helper()
|
|
tempDir := t.TempDir()
|
|
outputPath := filepath.Join(tempDir, "config.yaml")
|
|
|
|
err := exporter.ExportConfig(config, FormatYAML, outputPath)
|
|
if err != nil {
|
|
t.Fatalf("ExportConfig() error = %v", err)
|
|
}
|
|
|
|
verifyFileExists(t, outputPath)
|
|
verifyYAMLContent(t, outputPath, config)
|
|
}
|
|
}
|
|
|
|
// testJSONExport tests JSON export functionality.
|
|
func testJSONExport(exporter *ConfigExporter, config *internal.AppConfig) func(*testing.T) {
|
|
return func(t *testing.T) {
|
|
t.Helper()
|
|
tempDir := t.TempDir()
|
|
outputPath := filepath.Join(tempDir, "config.json")
|
|
|
|
err := exporter.ExportConfig(config, FormatJSON, outputPath)
|
|
if err != nil {
|
|
t.Fatalf("ExportConfig() error = %v", err)
|
|
}
|
|
|
|
verifyFileExists(t, outputPath)
|
|
verifyJSONContent(t, outputPath, config)
|
|
}
|
|
}
|
|
|
|
// testTOMLExport tests TOML export functionality.
|
|
func testTOMLExport(exporter *ConfigExporter, config *internal.AppConfig) func(*testing.T) {
|
|
return func(t *testing.T) {
|
|
t.Helper()
|
|
tempDir := t.TempDir()
|
|
outputPath := filepath.Join(tempDir, "config.toml")
|
|
|
|
err := exporter.ExportConfig(config, FormatTOML, outputPath)
|
|
if err != nil {
|
|
t.Fatalf("ExportConfig() error = %v", err)
|
|
}
|
|
|
|
verifyFileExists(t, outputPath)
|
|
verifyTOMLContent(t, outputPath)
|
|
}
|
|
}
|
|
|
|
// verifyFileExists checks that a file exists at the given path.
|
|
func verifyFileExists(t *testing.T, outputPath string) {
|
|
t.Helper()
|
|
if _, err := os.Stat(outputPath); os.IsNotExist(err) {
|
|
t.Fatal("Expected output file to exist")
|
|
}
|
|
}
|
|
|
|
// verifyYAMLContent verifies YAML content is valid and contains expected data.
|
|
func verifyYAMLContent(t *testing.T, outputPath string, expected *internal.AppConfig) {
|
|
t.Helper()
|
|
data, err := os.ReadFile(outputPath) // #nosec G304 -- test output path
|
|
if err != nil {
|
|
t.Fatalf("Failed to read output file: %v", err)
|
|
}
|
|
|
|
var yamlConfig internal.AppConfig
|
|
if err := yaml.Unmarshal(data, &yamlConfig); err != nil {
|
|
t.Fatalf("Failed to parse YAML: %v", err)
|
|
}
|
|
|
|
if yamlConfig.Organization != expected.Organization {
|
|
t.Errorf("Organization = %v, want %v", yamlConfig.Organization, expected.Organization)
|
|
}
|
|
if yamlConfig.Theme != expected.Theme {
|
|
t.Errorf("Theme = %v, want %v", yamlConfig.Theme, expected.Theme)
|
|
}
|
|
}
|
|
|
|
// verifyJSONContent verifies JSON content is valid and contains expected data.
|
|
func verifyJSONContent(t *testing.T, outputPath string, expected *internal.AppConfig) {
|
|
t.Helper()
|
|
data, err := os.ReadFile(outputPath) // #nosec G304 -- test output path
|
|
if err != nil {
|
|
t.Fatalf("Failed to read output file: %v", err)
|
|
}
|
|
|
|
var jsonConfig internal.AppConfig
|
|
if err := json.Unmarshal(data, &jsonConfig); err != nil {
|
|
t.Fatalf("Failed to parse JSON: %v", err)
|
|
}
|
|
|
|
if jsonConfig.Repository != expected.Repository {
|
|
t.Errorf("Repository = %v, want %v", jsonConfig.Repository, expected.Repository)
|
|
}
|
|
if jsonConfig.OutputFormat != expected.OutputFormat {
|
|
t.Errorf("OutputFormat = %v, want %v", jsonConfig.OutputFormat, expected.OutputFormat)
|
|
}
|
|
}
|
|
|
|
// verifyTOMLContent verifies TOML content contains expected fields.
|
|
func verifyTOMLContent(t *testing.T, outputPath string) {
|
|
t.Helper()
|
|
data, err := os.ReadFile(outputPath) // #nosec G304 -- test output path
|
|
if err != nil {
|
|
t.Fatalf("Failed to read output file: %v", err)
|
|
}
|
|
|
|
content := string(data)
|
|
if !strings.Contains(content, `organization = "testorg"`) {
|
|
t.Error("TOML should contain organization field")
|
|
}
|
|
if !strings.Contains(content, `theme = "github"`) {
|
|
t.Error("TOML should contain theme field")
|
|
}
|
|
}
|
|
|
|
func TestConfigExporter_sanitizeConfig(t *testing.T) {
|
|
t.Parallel()
|
|
output := internal.NewColoredOutput(true)
|
|
exporter := NewConfigExporter(output)
|
|
|
|
config := &internal.AppConfig{
|
|
Organization: "testorg",
|
|
Repository: "testrepo",
|
|
GitHubToken: "ghp_secret_token",
|
|
RepoOverrides: map[string]internal.AppConfig{
|
|
"test/repo": {Theme: "github"},
|
|
},
|
|
}
|
|
|
|
sanitized := exporter.sanitizeConfig(config)
|
|
|
|
// Verify sensitive data is removed
|
|
if sanitized.GitHubToken != "" {
|
|
t.Error("Expected GitHubToken to be empty after sanitization")
|
|
}
|
|
|
|
if sanitized.RepoOverrides != nil {
|
|
t.Error("Expected RepoOverrides to be nil after sanitization")
|
|
}
|
|
|
|
// Verify non-sensitive data is preserved
|
|
if sanitized.Organization != config.Organization {
|
|
t.Errorf("Organization = %v, want %v", sanitized.Organization, config.Organization)
|
|
}
|
|
if sanitized.Repository != config.Repository {
|
|
t.Errorf("Repository = %v, want %v", sanitized.Repository, config.Repository)
|
|
}
|
|
}
|
|
|
|
func TestConfigExporter_GetSupportedFormats(t *testing.T) {
|
|
t.Parallel()
|
|
output := internal.NewColoredOutput(true)
|
|
exporter := NewConfigExporter(output)
|
|
|
|
formats := exporter.GetSupportedFormats()
|
|
|
|
expectedFormats := []ExportFormat{FormatYAML, FormatJSON, FormatTOML}
|
|
if len(formats) != len(expectedFormats) {
|
|
t.Errorf("GetSupportedFormats() returned %d formats, want %d", len(formats), len(expectedFormats))
|
|
}
|
|
|
|
// Check that all expected formats are present
|
|
formatMap := make(map[ExportFormat]bool)
|
|
for _, format := range formats {
|
|
formatMap[format] = true
|
|
}
|
|
|
|
for _, expected := range expectedFormats {
|
|
if !formatMap[expected] {
|
|
t.Errorf("Expected format %v not found in supported formats", expected)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestConfigExporter_GetDefaultOutputPath(t *testing.T) {
|
|
t.Parallel()
|
|
output := internal.NewColoredOutput(true)
|
|
exporter := NewConfigExporter(output)
|
|
|
|
tests := []struct {
|
|
format ExportFormat
|
|
expected string
|
|
}{
|
|
{FormatYAML, "config.yaml"},
|
|
{FormatJSON, "config.json"},
|
|
{FormatTOML, "config.toml"},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(string(tt.format), func(t *testing.T) {
|
|
t.Parallel()
|
|
path, err := exporter.GetDefaultOutputPath(tt.format)
|
|
if err != nil {
|
|
t.Fatalf("GetDefaultOutputPath() error = %v", err)
|
|
}
|
|
|
|
if !strings.HasSuffix(path, tt.expected) {
|
|
t.Errorf("GetDefaultOutputPath() = %v, should end with %v", path, tt.expected)
|
|
}
|
|
})
|
|
}
|
|
|
|
// Test invalid format
|
|
t.Run("invalid format", func(t *testing.T) {
|
|
_, err := exporter.GetDefaultOutputPath("invalid")
|
|
if err == nil {
|
|
t.Error("Expected error for invalid format")
|
|
}
|
|
})
|
|
}
|