ansible-collections/community.postgresql

have a `comment` argument wherever an object is created

Aberta

#354 aberto em 12 de out. de 2022

Ver no GitHubGuia do colaborador
 (3 comentários) (3 reações) (0 responsável)Python (116 forks)auto 404
help wanted

Métricas do repositório

Stars
 (142 estrelas)
Métricas de merge de PR
 (Mesclagem média 13d 5h) (3 fundiu PRs em 30d)

Description

  From a user perspective I think it would be more convenient to have a `comment` argument wherever an object is created. To only change a comment, they need to be idempotent. At a quick glance, the argument would suit 11 modules:
  • postgresql_db: #646
  • postgresql_ext: #652
  • postgresql_idx
  • postgresql_lang (deprecated)
  • postgresql_publication: #654
  • postgresql_schema: #650
  • postgresql_sequence
  • postgresql_subscription: #655
  • postgresql_table
  • postgresql_tablespace: #651
  • postgresql_user: #649 (already had the feature, uses the shared function now)
  • add the comment argument value to check_input(...), check across all the modules
  • check reset functionality in all the modules except publication for consistency
  • add check_mode + mogrify to set_comment, fix tests across all the modules where it makes sense

I'd say the benefit of a comment argument or postgresql_comment module over postgresql_query is that we can validate the kind of object which is commented, to avoid SQL injections. As this is part of the query syntax, not a variable, we cannot rely on psycopg2/3 variable escaping.

Originally posted by @betanummeric in https://github.com/ansible-collections/community.postgresql/discussions/352#discussioncomment-3834647

Guia do colaborador

Direção de pesquisa
Implemente o argumento `comment` para os módulos restantes (postgresql idx, postgresql sequence, postgresql table) seguindo o padrão estabelecido nos módulos concluídos, como postgresql schema. Garanta a idempotência e utilize as funções compartilhadas `check input` e `set comment`.
Pilha de tecnologia
pythonpostgresql
Domain
backenddatabase
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
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.
Principalmente claro
Prerequisites
PythonPostgreSQLAnsible module development
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60