secdev/scapy

doc/scapy is not reproducibly built

Open

#3.871 aberto em 26 de jan. de 2023

Ver no GitHub
 (6 comments) (0 reactions) (0 assignees)Python (1.949 forks)batch import
bugdochelp wanted

Métricas do repositório

Stars
 (9.312 stars)
Métricas de merge de PR
 (Mesclagem média 5d 20h) (15 fundiu PRs em 30d)

Description

Brief description

Hi

There is an ongoing effort regarding reproducible builds in Debian so we have tests checking for it. scapy - actually python-scapy-doc package which contains scapy's documentation - is currently not building reproducibly. There are some places where the date/time of the build is embedded and others are randomly generated.

The html pages that differ are:

  • html/api/scapy.contrib.dtp.html
  • html/api/scapy.contrib.gtp.html
  • html/api/scapy.contrib.http2.html
  • html/api/scapy.contrib.skinny.html
  • html/api/scapy.layers.inet.html
  • html/api/scapy.layers.kerberos.html
  • html/api/scapy.layers.snmp.html
  • html/api/scapy.layers.x509.html

I'll attach the diffoscope output here because github doesn't let me paste it ;-)

experiment-1.diffoscope.txt

Scapy version

2.5.0

Python version

3.10

Operating system

Debian unstable

Additional environment information

No response

How to reproduce

Diffoscope two different builds of scapy's documentation

Actual result

No response

Expected result

No response

Related resources

No response

Guia do colaborador

Direção de pesquisa
Examine a saída do diffoscope para identificar fontes de não determinismo nos arquivos html. Os problemas provavelmente são timestamps ou IDs aleatórios inseridos durante a geração da documentação. Para corrigir, certifique se de que as ferramentas de build respeitem SOURCE DATE EPOCH ou remova as incorporações de data. Verifique arquivos como html/api/scapy.contrib.dtp.html etc. e ajuste a configuração ou os templates do Sphinx para produzir saída reproduzível.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80