Namcap (Português)

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Status de tradução: Esse artigo é uma tradução de Namcap. Data da última tradução: 2018-10-30. Você pode ajudar a sincronizar a tradução, se houver alterações na versão em inglês.

Namcap é uma ferramenta para verificar pacotes binários e PKGBUILDs fonte para erros comuns de empacotamento, que também pode ser habilitado automaticamente. Ele foi criado por Jason Chu.

Alterações: O arquivo NEWS no repositório Git contém as alterações em relação versões anteriores de forma concisa.

Ramo de desenvolvimento: https://gitlab.archlinux.org/pacman/namcap

Para fazer um relato de erro ou requisição de recurso para o namcap, preencha um relatório na seção Packages:Extra do rastreador de erros do Arch Linux e defina a importância conforme o caso. Se você está relatando um erro, por favor forneça exemplos concretos de pacotes nos quais o problema ocorra e lembre-se de inserir o número de versão.

Se você tem um patch (corrigindo um erro ou adicionando um novo módulo para o namcap), você pode enviá-lo para a lista de discussão arch-projects. O desenvolvimento do namcap é gerenciado com git, então patches formatados em git são preferíveis.

Instalação

Instale o pacote namcap.

Como usá-lo

Para executar o namcap em um arquivo, sendo nome_de_arquivo o PKGBUILD ou o nome de um binário pkg.tar.xz:

$ namcap nome_de_arquivo

Se você deseja ver mensagens informacionais extras, chame o namcap com a opção -i:

$ namcap -i nome_de_arquivo

Para mais informações sobre uso, veja a página man namcap(1).

Entendendo a saída

O namcap usa um sistema de tags para classificar a saída. Atualmente, as tags são de três tipos, erros (denotados por E), avisos (denotados por W) e informativo (denotado por I). Um erro é importante e deve ser corrigido imediatamente; principalmente se eles referem a segurança insuficiente, falta de licença ou problemas de permissão.

Normalmente, o namcap imprime uma explicação legível por humanos (às vezes com sugestões sobre como solucionar o problema). Se quiser saída que pode ser facilmente analisada por um programa, passe a opção -m (legível para máquina) para o namcap (esse recurso está atualmente no ramo de desenvolvimento).

Fazendo um módulo de namcap

Esta seção documenta as partes internas do namcap e especifica como criar um novo módulo namcap.

O programa principal do namcap, o namcap.py, toma como parâmetros o nome de arquivo de um pacote ou um PKGBUILD e faz um objeto pkginfo, o qual ele passa para uma lista de regras definidas em __tarball__ e __pkgbuild__.

__tarball__ define as regras que processam os pacotes binários.
__pkgbuild__ define as regras que processam os PKGBUILDs

Uma vez que seu módulo esteja finalizado, lembre-se de adicioná-lo para o vetor apropriado (__tarball__ ou __pkgbuild__) definido em Namcap/__init__.py

Um exemplo de módulo de namcap é assim:

namcap/url.py

  import pacman

  class package:
  	def short_name(self):
		return "url"
	def long_name(self):
		return "Verifies url is included in a PKGBUILD"
	def prereq(self):
		return ""
	def analyze(self, pkginfo, tar):
		ret = [[],[],[]]
		if not hasattr(pkginfo, 'url'):
			ret[0].append(("missing-url", ()))
		return ret
	def type(self):
		return "pkgbuild"

Em sua maioria, o código é autoexplicatório. A seguir segue a lista de métodos que cada módulo do namcap deve ter:

short_name(self) Retorna uma string contendo um nome curto do módulo. Geralmente, isso é o mesmo que o nome base do arquivo do módulo.
long_name(self) Retorna uma string contendo uma descrição concisa do módulo. Essa descrição é usada ao listar todas as regras usando namcap -r list.
prereq(self) Retorna uma string contendo os pré-requisitos necessários para o módulo funcionar corretamente. Geralmente "" para módulos processando PKGBUILDs e "tar" por módulos processando arquivos de pacote. "extract" deve ser especificado se o conteúdo do pacote deve ser extraído para um diretório temporário antes de processamento adicional.
analyze(self, pkginfo, tar) Deve retornar uma lista que inclua, por sua vez, três listas: de tags de erro, tags de aviso e tags de informações, respectivamente. Cada membro dessas listas de tags deve ser uma tupla consistindo de dois componentes: a forma curta e hifenizada da tag com os especificadores de formato apropriado (%s, etc). A primeira palavra desta string deve ser o nome da tag. A forma legível por humanos desta tag deve ser coloca no arquivo de tags. O formato do arquivo de tags é descrito abaixo; e os parâmetros que devem substituir os tokens especificadores de formato na saída final.
type(self) "pkgbuild" para um módulos processando PKGBUILDs, "tarball" para um módulo processando um arquivo de pacote binário.

O arquivo de tags consiste de linhas especificando a forma legível por humanos das tags hifenizadas usadas no código do namcap. Uma linha começando com um '#' é tratada como um comentário. Do contrário, o formato do arquivo é:

 machine-parseable-tag %s :: This is machine parseable tag %s

Note que uma dupla de caracteres de dois pontos (::) é usada para separar a tag hifenizada da descrição legível por humanos.

Relatórios do namcap

namcap-reports é um relatório gerado automaticamente obtido após executar o namcap nas árvores dos repositórios core, extra e community.

Como ele funciona:

O namcap é executado em toda árvore do ABS para criar namcap.log.
Os pacotes nos repositórios core, extra e community são colocados em arquivos com nomes core, extra e community, respectivamente (usando pacman -Slq).
namcap-report.py leva o código e prepara o relatório e feeds RSS, que é então copiado para o servidor web.

Namcap (Português)

Contents

Instalação

Como usá-lo

Entendendo a saída

Tags

Links simbólicos

Depedências

Licenças

Arquivos

Diversos

PKGBUILDs

Não lançadas

Fazendo um módulo de namcap

Relatórios do namcap