This commit is contained in:
2025-08-04 11:03:25 +03:00
commit b1bde827de
20 changed files with 3579 additions and 0 deletions

266
example/main.go Normal file
View File

@@ -0,0 +1,266 @@
// Package main демонстрирует использование библиотеки benadis-rac
// для управления сервисным режимом 1C
package main
import (
"context"
"fmt"
"log"
"os"
"time"
benadisrac "git.benadis.ru/gitops/benadis-rac"
)
// ExampleConfig содержит примеры конфигурации для демонстрации
type ExampleConfig struct {
ConfigPath string
SecretPath string
ProjectPath string
LogLevel string
}
// getDefaultConfig возвращает конфигурацию по умолчанию
func getDefaultConfig() ExampleConfig {
return ExampleConfig{
ConfigPath: "../config.yaml",
SecretPath: "../secret.yaml",
ProjectPath: "../project.yaml",
LogLevel: "Info",
}
}
// demonstrateBasicUsage демонстрирует базовое использование библиотеки
func demonstrateBasicUsage() error {
fmt.Println("=== Демонстрация базового использования библиотеки GitOps RAC ===")
// Получаем конфигурацию
cfg := getDefaultConfig()
// Создаем клиент
fmt.Println("Создание клиента...")
client, err := benadisrac.NewClient(benadisrac.Config{
ConfigPath: cfg.ConfigPath,
SecretPath: cfg.SecretPath,
ProjectPath: cfg.ProjectPath,
LogLevel: cfg.LogLevel,
})
if err != nil {
return fmt.Errorf("ошибка создания клиента: %w", err)
}
fmt.Println("✓ Клиент успешно создан")
// Создаем контекст с таймаутом
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
// Получаем текущий статус
fmt.Println("\nПроверка текущего статуса сервисного режима...")
status, err := client.GetServiceModeStatus(ctx)
if err != nil {
return fmt.Errorf("ошибка получения статуса: %w", err)
}
fmt.Printf("✓ Текущий статус сервисного режима: %t\n", status)
return nil
}
// demonstrateServiceModeOperations демонстрирует операции с сервисным режимом
func demonstrateServiceModeOperations() error {
fmt.Println("\n=== Демонстрация операций с сервисным режимом ===")
// Создаем клиент
cfg := getDefaultConfig()
client, err := benadisrac.NewClient(benadisrac.Config{
ConfigPath: cfg.ConfigPath,
SecretPath: cfg.SecretPath,
ProjectPath: cfg.ProjectPath,
LogLevel: "Debug", // Используем Debug для подробного логирования
})
if err != nil {
return fmt.Errorf("ошибка создания клиента: %w", err)
}
ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
defer cancel()
// Получаем начальный статус
initialStatus, err := client.GetServiceModeStatus(ctx)
if err != nil {
return fmt.Errorf("ошибка получения начального статуса: %w", err)
}
fmt.Printf("Начальный статус: %t\n", initialStatus)
// Если сервисный режим выключен, включаем его
if !initialStatus {
fmt.Println("\nВключение сервисного режима...")
if err := client.EnableServiceMode(ctx); err != nil {
return fmt.Errorf("ошибка включения сервисного режима: %w", err)
}
fmt.Println("✓ Сервисный режим включен")
// Проверяем статус после включения
status, err := client.GetServiceModeStatus(ctx)
if err != nil {
return fmt.Errorf("ошибка проверки статуса после включения: %w", err)
}
fmt.Printf("✓ Статус после включения: %t\n", status)
// Ждем немного
time.Sleep(2 * time.Second)
// Выключаем сервисный режим
fmt.Println("\nВыключение сервисного режима...")
if err := client.DisableServiceMode(ctx); err != nil {
return fmt.Errorf("ошибка выключения сервисного режима: %w", err)
}
fmt.Println("✓ Сервисный режим выключен")
} else {
fmt.Println("\nВыключение сервисного режима...")
if err := client.DisableServiceMode(ctx); err != nil {
return fmt.Errorf("ошибка выключения сервисного режима: %w", err)
}
fmt.Println("✓ Сервисный режим выключен")
// Проверяем статус после выключения
status, err := client.GetServiceModeStatus(ctx)
if err != nil {
return fmt.Errorf("ошибка проверки статуса после выключения: %w", err)
}
fmt.Printf("✓ Статус после выключения: %t\n", status)
// Ждем немного
time.Sleep(2 * time.Second)
// Включаем сервисный режим обратно
fmt.Println("\nВключение сервисного режима обратно...")
if err := client.EnableServiceMode(ctx); err != nil {
return fmt.Errorf("ошибка включения сервисного режима: %w", err)
}
fmt.Println("✓ Сервисный режим включен обратно")
}
// Финальная проверка статуса
finalStatus, err := client.GetServiceModeStatus(ctx)
if err != nil {
return fmt.Errorf("ошибка получения финального статуса: %w", err)
}
fmt.Printf("\n✓ Финальный статус: %t\n", finalStatus)
return nil
}
// demonstrateErrorHandling демонстрирует обработку ошибок
func demonstrateErrorHandling() {
fmt.Println("\n=== Демонстрация обработки ошибок ===")
// Попытка создать клиент с неверными путями
fmt.Println("Попытка создания клиента с неверными путями...")
_, err := benadisrac.NewClient(benadisrac.Config{
ConfigPath: "nonexistent-config.yaml",
SecretPath: "nonexistent-secret.yaml",
ProjectPath: "nonexistent-project.yaml",
LogLevel: "Info",
})
if err != nil {
fmt.Printf("✓ Ожидаемая ошибка: %v\n", err)
} else {
fmt.Println("⚠ Неожиданно: ошибка не возникла")
}
// Попытка создать клиент с неверным уровнем логирования
fmt.Println("\nПопытка создания клиента с неверным уровнем логирования...")
cfg := getDefaultConfig()
cfg.LogLevel = "InvalidLevel"
client, err := benadisrac.NewClient(benadisrac.Config{
ConfigPath: cfg.ConfigPath,
SecretPath: cfg.SecretPath,
ProjectPath: cfg.ProjectPath,
LogLevel: cfg.LogLevel,
})
if err != nil {
fmt.Printf("✓ Ошибка при неверном уровне логирования: %v\n", err)
} else if client != nil {
fmt.Println("✓ Клиент создан, но может использовать уровень логирования по умолчанию")
}
}
// printUsageInstructions выводит инструкции по использованию
func printUsageInstructions() {
fmt.Println("\n=== Инструкции по использованию библиотеки GitOps RAC ===")
fmt.Println("\n1. Импортируйте библиотеку:")
fmt.Println(` import benadisrac "git.benadis.ru/gitops/benadis-rac/"`)
fmt.Println("\n2. Создайте конфигурацию:")
fmt.Println(` cfg := benadisrac.Config{`)
fmt.Println(` ConfigPath: "config.yaml",`)
fmt.Println(` SecretPath: "secret.yaml",`)
fmt.Println(` ProjectPath: "project.yaml",`)
fmt.Println(` LogLevel: "Info",`)
fmt.Println(` }`)
fmt.Println("\n3. Создайте клиент:")
fmt.Println(` client, err := benadisrac.NewClient(cfg)`)
fmt.Println(` if err != nil {`)
fmt.Println(` log.Fatal(err)`)
fmt.Println(` }`)
fmt.Println("\n4. Используйте методы клиента:")
fmt.Println(` ctx := context.Background()`)
fmt.Println(` status, err := client.GetServiceModeStatus(ctx)`)
fmt.Println(` err = client.EnableServiceMode(ctx)`)
fmt.Println(` err = client.DisableServiceMode(ctx)`)
fmt.Println("\n5. Доступные уровни логирования: Debug, Info, Warn, Error")
fmt.Println("\n6. Все операции поддерживают context.Context для управления таймаутами")
}
func main() {
fmt.Println("GitOps RAC Library Example")
fmt.Println("==========================")
// Проверяем аргументы командной строки
if len(os.Args) > 1 {
switch os.Args[1] {
case "--help", "-h":
printUsageInstructions()
return
case "--basic":
if err := demonstrateBasicUsage(); err != nil {
log.Printf("Ошибка в базовой демонстрации: %v", err)
}
return
case "--operations":
if err := demonstrateServiceModeOperations(); err != nil {
log.Printf("Ошибка в демонстрации операций: %v", err)
}
return
case "--errors":
demonstrateErrorHandling()
return
}
}
// Выполняем все демонстрации по умолчанию
fmt.Println("Запуск всех демонстраций...")
fmt.Println("Используйте флаги: --basic, --operations, --errors, --help")
fmt.Println()
// Базовое использование
if err := demonstrateBasicUsage(); err != nil {
log.Printf("Ошибка в базовой демонстрации: %v", err)
}
// Операции с сервисным режимом (только если базовая демонстрация прошла успешно)
if err := demonstrateServiceModeOperations(); err != nil {
log.Printf("Ошибка в демонстрации операций: %v", err)
}
// Обработка ошибок
demonstrateErrorHandling()
// Инструкции
printUsageInstructions()
fmt.Println("\n=== Демонстрация завершена ===")
}

337
example/main_test.go Normal file
View File

@@ -0,0 +1,337 @@
package main
import (
"context"
"os"
"testing"
"time"
benadisrac "git.benadis.ru/gitops/benadis-rac"
)
// TestGetDefaultConfig тестирует функцию получения конфигурации по умолчанию
func TestGetDefaultConfig(t *testing.T) {
cfg := getDefaultConfig()
if cfg.ConfigPath == "" {
t.Error("ConfigPath не должен быть пустым")
}
if cfg.SecretPath == "" {
t.Error("SecretPath не должен быть пустым")
}
if cfg.ProjectPath == "" {
t.Error("ProjectPath не должен быть пустым")
}
if cfg.LogLevel == "" {
t.Error("LogLevel не должен быть пустым")
}
// Проверяем ожидаемые значения
expected := ExampleConfig{
ConfigPath: "../config.yaml",
SecretPath: "../secret.yaml",
ProjectPath: "../project.yaml",
LogLevel: "Info",
}
if cfg != expected {
t.Errorf("Неожиданная конфигурация. Получено: %+v, ожидалось: %+v", cfg, expected)
}
}
// TestClientCreation тестирует создание клиента с различными конфигурациями
func TestClientCreation(t *testing.T) {
tests := []struct {
name string
config benadisrac.Config
expectError bool
}{
{
name: "Валидная конфигурация",
config: benadisrac.Config{
ConfigPath: "../config.yaml",
SecretPath: "../secret.yaml",
ProjectPath: "../project.yaml",
LogLevel: "Info",
},
expectError: false,
},
{
name: "Несуществующий файл конфигурации",
config: benadisrac.Config{
ConfigPath: "nonexistent.yaml",
SecretPath: "../secret.yaml",
ProjectPath: "../project.yaml",
LogLevel: "Info",
},
expectError: true,
},
{
name: "Несуществующий файл секретов",
config: benadisrac.Config{
ConfigPath: "../config.yaml",
SecretPath: "nonexistent.yaml",
ProjectPath: "../project.yaml",
LogLevel: "Info",
},
expectError: true,
},
{
name: "Несуществующий файл проекта",
config: benadisrac.Config{
ConfigPath: "../config.yaml",
SecretPath: "../secret.yaml",
ProjectPath: "nonexistent.yaml",
LogLevel: "Info",
},
expectError: true,
},
{
name: "Пустые пути (должны использоваться значения по умолчанию)",
config: benadisrac.Config{
LogLevel: "Debug",
},
expectError: true, // Файлы по умолчанию не существуют в example директории
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
client, err := benadisrac.NewClient(tt.config)
if tt.expectError {
if err == nil {
t.Error("Ожидалась ошибка, но её не было")
}
if client != nil {
t.Error("Клиент не должен быть создан при ошибке")
}
} else {
if err != nil {
t.Errorf("Неожиданная ошибка: %v", err)
}
if client == nil {
t.Error("Клиент должен быть создан")
}
}
})
}
}
// TestClientOperations тестирует операции клиента (требует валидную конфигурацию)
func TestClientOperations(t *testing.T) {
// Проверяем наличие файлов конфигурации
cfg := getDefaultConfig()
if !fileExists(cfg.ConfigPath) || !fileExists(cfg.SecretPath) || !fileExists(cfg.ProjectPath) {
t.Skip("Пропускаем тест: файлы конфигурации не найдены")
}
client, err := benadisrac.NewClient(benadisrac.Config{
ConfigPath: cfg.ConfigPath,
SecretPath: cfg.SecretPath,
ProjectPath: cfg.ProjectPath,
LogLevel: "Info",
})
if err != nil {
t.Fatalf("Ошибка создания клиента: %v", err)
}
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
// Тестируем получение статуса
t.Run("GetServiceModeStatus", func(t *testing.T) {
status, err := client.GetServiceModeStatus(ctx)
if err != nil {
t.Errorf("Ошибка получения статуса: %v", err)
}
// Статус может быть true или false, оба варианта валидны
t.Logf("Текущий статус сервисного режима: %t", status)
})
// Тестируем включение сервисного режима
t.Run("EnableServiceMode", func(t *testing.T) {
err := client.EnableServiceMode(ctx)
if err != nil {
t.Errorf("Ошибка включения сервисного режима: %v", err)
}
})
// Тестируем выключение сервисного режима
t.Run("DisableServiceMode", func(t *testing.T) {
err := client.DisableServiceMode(ctx)
if err != nil {
t.Errorf("Ошибка выключения сервисного режима: %v", err)
}
})
}
// TestClientWithContext тестирует работу с контекстом
func TestClientWithContext(t *testing.T) {
cfg := getDefaultConfig()
if !fileExists(cfg.ConfigPath) || !fileExists(cfg.SecretPath) || !fileExists(cfg.ProjectPath) {
t.Skip("Пропускаем тест: файлы конфигурации не найдены")
}
client, err := benadisrac.NewClient(benadisrac.Config{
ConfigPath: cfg.ConfigPath,
SecretPath: cfg.SecretPath,
ProjectPath: cfg.ProjectPath,
LogLevel: "Info",
})
if err != nil {
t.Fatalf("Ошибка создания клиента: %v", err)
}
// Тестируем таймаут контекста
t.Run("ContextTimeout", func(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Millisecond)
defer cancel()
// Ждем, чтобы контекст истек
time.Sleep(2 * time.Millisecond)
_, err := client.GetServiceModeStatus(ctx)
if err == nil {
t.Log("Операция завершилась быстрее таймаута или таймаут не обрабатывается")
} else {
t.Logf("Ожидаемая ошибка таймаута: %v", err)
}
})
// Тестируем отмену контекста
t.Run("ContextCancellation", func(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
cancel() // Отменяем контекст сразу
_, err := client.GetServiceModeStatus(ctx)
if err == nil {
t.Log("Операция завершилась до проверки отмены или отмена не обрабатывается")
} else {
t.Logf("Ожидаемая ошибка отмены: %v", err)
}
})
}
// TestDemonstrateBasicUsage тестирует функцию демонстрации базового использования
func TestDemonstrateBasicUsage(t *testing.T) {
cfg := getDefaultConfig()
if !fileExists(cfg.ConfigPath) || !fileExists(cfg.SecretPath) || !fileExists(cfg.ProjectPath) {
t.Skip("Пропускаем тест: файлы конфигурации не найдены")
}
err := demonstrateBasicUsage()
if err != nil {
t.Errorf("Ошибка в демонстрации базового использования: %v", err)
}
}
// TestDemonstrateErrorHandling тестирует функцию демонстрации обработки ошибок
func TestDemonstrateErrorHandling(t *testing.T) {
// Эта функция не должна вызывать панику
defer func() {
if r := recover(); r != nil {
t.Errorf("Функция demonstrateErrorHandling вызвала панику: %v", r)
}
}()
demonstrateErrorHandling()
}
// TestMainWithArguments тестирует обработку аргументов командной строки
func TestMainWithArguments(t *testing.T) {
tests := []struct {
name string
args []string
}{
{"Help", []string{"program", "--help"}},
{"Help short", []string{"program", "-h"}},
{"Errors", []string{"program", "--errors"}},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Сохраняем оригинальные аргументы
origArgs := os.Args
defer func() { os.Args = origArgs }()
// Устанавливаем тестовые аргументы
os.Args = tt.args
// Проверяем, что функции не вызывают панику
defer func() {
if r := recover(); r != nil {
t.Errorf("Функция вызвала панику с аргументами %v: %v", tt.args, r)
}
}()
// Тестируем отдельные функции вместо main()
switch tt.name {
case "Help", "Help short":
printUsageInstructions()
case "Errors":
demonstrateErrorHandling()
}
})
}
}
// Вспомогательные функции
// fileExists проверяет существование файла
func fileExists(filename string) bool {
_, err := os.Stat(filename)
return !os.IsNotExist(err)
}
// BenchmarkClientCreation бенчмарк создания клиента
func BenchmarkClientCreation(b *testing.B) {
cfg := getDefaultConfig()
if !fileExists(cfg.ConfigPath) || !fileExists(cfg.SecretPath) || !fileExists(cfg.ProjectPath) {
b.Skip("Пропускаем бенчмарк: файлы конфигурации не найдены")
}
config := benadisrac.Config{
ConfigPath: cfg.ConfigPath,
SecretPath: cfg.SecretPath,
ProjectPath: cfg.ProjectPath,
LogLevel: "Info",
}
b.ResetTimer()
for i := 0; i < b.N; i++ {
client, err := benadisrac.NewClient(config)
if err != nil {
b.Fatalf("Ошибка создания клиента: %v", err)
}
_ = client
}
}
// BenchmarkGetStatus бенчмарк получения статуса
func BenchmarkGetStatus(b *testing.B) {
cfg := getDefaultConfig()
if !fileExists(cfg.ConfigPath) || !fileExists(cfg.SecretPath) || !fileExists(cfg.ProjectPath) {
b.Skip("Пропускаем бенчмарк: файлы конфигурации не найдены")
}
client, err := benadisrac.NewClient(benadisrac.Config{
ConfigPath: cfg.ConfigPath,
SecretPath: cfg.SecretPath,
ProjectPath: cfg.ProjectPath,
LogLevel: "Info",
})
if err != nil {
b.Fatalf("Ошибка создания клиента: %v", err)
}
ctx := context.Background()
b.ResetTimer()
for i := 0; i < b.N; i++ {
_, err := client.GetServiceModeStatus(ctx)
if err != nil {
b.Fatalf("Ошибка получения статуса: %v", err)
}
}
}