[testify-expert] Improve Test Quality: pkg/cli/codemod_copilot_web_fetch_test.go

Abierto Apto para principiantes
  • ¿Algo no está bien?
#74,912 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
github-actions, go
Área
testing

Línea de trabajo

Lee pkg/cli/codemod_copilot_web_fetch_test.go junto con pkg/cli/codemod_copilot_web_fetch.go y el pkg/cli/codemod_copilot_web_search_test.go relacionado. Empieza por los casos que faltan de isNestedWorkflowFragment y los casos de paridad de la búsqueda web; después, comprueba el frontmatter mal formado y el comportamiento con motores que no sean Copilot. El trabajo estará terminado cuando las pruebas añadidas cubran los casos enumerados y pasen con el comando de prueba existente del paquete.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

automated-analysis code-quality cookie enhancement report safe-outputs testing workflows
Current State
  • Test file: pkg/cli/codemod_copilot_web_fetch_test.go (316 LOC, 7 test functions, 3 t.Run)
  • Source: pkg/cli/codemod_copilot_web_fetch.go (getCopilotWebFetchRemovalCodemod, getCopilotWebSearchRemovalCodemod, applyCopilotWebToolRemoval, isNestedWorkflowFragment)
  • testify: already uses assert (21) and require (25); t.Parallel() used.
Strengths
  • Good require-for-preconditions / assert-for-values split.
  • Idempotency check (apply twice) in _Apply.
  • Covers included-engine resolution and failure-preserves-setting paths.
Prioritized improvements
1. Missing / high-value tests
  • isNestedWorkflowFragment has no direct test. Add a table test: "", .github/workflows/a.md (false), .github/workflows/shared/a.md (true), workflows/a.md (false), a/b.md without workflows (false), Windows-style separators, paths with ...
  • getCopilotWebSearchRemovalCodemod metadata (ID copilot-web-search-removal, IntroducedIn) and the web-search branch of applyCopilotWebToolRemoval are only covered in codemod_copilot_web_search_test.go; add a shared table over both codemods (tool key param) to guarantee parity.
  • Error path: Apply with malformed frontmatter / tools of non-map type should return unchanged content without error (assert explicitly).
  • Non-Copilot engine (e.g. claude) with web-fetch: true must be left unchanged.
2. Testify assertion upgrades
  • Metadata test: use assert.NotNil -> require.NotNil before invoking (already done) and add assert.Equal on Name/Description non-empty via assert.NotEmpty (present) — consider also asserting ID uniqueness against the registry (assert.Len of IDs set).
  • Use assert.Equal(t, updated, updatedAgain) -> assert.Equal is fine; prefer assert.YAMLEq only for frontmatter fragments, keep exact string equality for full-file output.
  • Add messages to key require.True(t, applied, "codemod should apply") for easier failure diagnosis.
3. Table-driven refactors

_CompatibleInputsAreUnchanged and _YAMLFormsAndLiteralText (lines ~67-220) are candidates for []struct{name, content, frontmatter, want, wantApplied} with t.Run(tt.name, ...) and t.Parallel() per subtest.

Before:

updated, applied, err := codemod.Apply(content, fm)
require.NoError(t, err)
assert.False(t, applied)

After:

for _, tt := range tests {
    t.Run(tt.name, func(t *testing.T) {
        t.Parallel()
        got, applied, err := codemod.Apply(tt.content, tt.fm)
        require.NoError(t, err)
        assert.Equal(t, tt.wantApplied, applied)
        assert.Equal(t, tt.want, got)
    })
}
4. Organization / readability
  • Extract a small helper for building engine/tools frontmatter maps to cut repeated literals.
  • Name tests by behavior (e.g. _RemovesWebFetchWithCopilotEngine).
  • Group file-resolution tests (ResolvesIncludedEngine, PreservesSettingWhenEngineResolutionFails) using shared temp-dir setup helper.

Generated by 🧪 Daily Testify Uber Super Expert · copilot · auto (powered by Gemini 3.8 Flash) · ~14 AIC · ⌖ ~1 AIC · ⊞ 9.2K · ◷

  • expires on Nov 6, 2026, 10:05 AM UTC-08:00
Lenguaje dominante
Go
Estrellas
5.6k
Forks
615
Merge medio
5 h 19 min
PR fusionados (30 d)
798

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github/gh-aw

Todos los issues de github/gh-aw

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.