cli-plugins/hooks: max-message enforcement is off by one

Abierto Apto para principiantes
#7,005 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
74/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
go
Área
cli

Línea de trabajo

Empieza en cli-plugins/hooks/template.go, en las líneas 43 y 46, e inspecciona hooks.ParseTemplate() con la reproducción de 11 líneas del issue. Añade una prueba de regresión que muestre que se rechazan 10 caracteres de salto de línea, mientras que las salidas dentro del límite de 10 mensajes siguen siendo válidas; se considera terminado cuando ninguna línea adicional se fusiona con el mensaje final.

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

Descripción

Description

cli-plugins/hooks.ParseTemplate() currently enforces maxMessages = 10 by counting newline characters and rejecting only when strings.Count(out, "\n") > maxMessages, then returning strings.SplitN(out, "\n", maxMessages).

That makes the limit off by one:

  • a template that renders to 10 newline characters actually contains 11 messages
  • that output is currently accepted instead of rejected
  • SplitN(..., 10) then merges the extra line into the last returned element, so the final "message" can still contain an embedded newline

This means the "maximum 10 messages" guard can be bypassed by one extra rendered line.

Reproduce
  1. Use the current master branch.
  2. Call hooks.ParseTemplate() with output that contains 11 lines, for example:
strings.Repeat("line\n", 10) + "line"
  1. Observe that no error is returned.
  2. Observe that the returned slice has length 10, with the last element containing an embedded newline.

The relevant logic is currently in:

  • cli-plugins/hooks/template.go:43
  • cli-plugins/hooks/template.go:46
Expected behavior

A template that renders to more than 10 messages should be rejected, including the 11-line / 10-newline case.

In other words, the limit should be enforced on the number of returned messages, not just on the number of newline separators.

docker version

N/A for runtime environment. This is a source-level issue in the current master branch checkout.

Observed in local checkout at 9f16882de4.

docker info

N/A for runtime environment. This issue is in template parsing logic and does not depend on daemon configuration.

Additional Info

This looks like it was introduced by b7ab63387a (cli-plugins/hooks: limit maximum number of lines / messages).

I’m happy to send a fix with a regression test if this behavior matches the intended bug report.

Lenguaje dominante
Go
Estrellas
6.1k
Forks
2.2k
Merge medio
1 d 15 h
PR fusionados (30 d)
43

Guía de contribución

Abrir la guía de contribución

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 docker/cli

Todos los issues de docker/cli

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.