Rótulo do objeto uip tm

Sintaxe e opções para "uip tm objectlabel", que gerencia rótulos anexados a objetos do Test Manager, como casos de teste e requisitos.

uip tm objectlabel gerencia rótulos anexados a objetos do Test Manager (requisitos, casos de teste, conjuntos de testes, execuções de teste e logs de casos de teste). Rótulos são strings de forma livre usadas para marcar e agrupar objetos para filtragem e pesquisa.

Importante:

--project-key e --object-type são necessários em cada verbo nesse grupo, incluindo get. --object-ids e --labels são múltiplos e separados por espaço ao longo do processo; as formas únicas --object-id e --label não existem.

Resumo

uip tm objectlabel list --project-key <key> --object-type <type> [--object-ids <uuid...>] [--label-types <types...>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm objectlabel get --project-key <key> --object-type <type> --label-id <uuid>
uip tm objectlabel add --project-key <key> --object-type <type> --object-ids <uuid...> --labels <name...> [--label-type <type>] [--remove-other-labels]
uip tm objectlabel remove --project-key <key> --object-type <type> --object-ids <uuid...> (--labels <name...> | --remove-all-labels) [-y]

Todos os verbos honram as opções globais e os códigos de saída padrão. Cada verbo aceita --log-level <level> (padrão Information) e -t, --tenant <name> (o padrão é o tenant autenticado).

--object-type aceita Requirement, TestCase, TestSet, TestExecution ou TestCaseLog. --label-type/--label-types aceita os valores de formulário conectado userLabel, systemLabel, internalLabel — não os formulários PascalCase usados em outro lugar nesta CLI.

lista de rótulos de objetos uip tm

Lista nomes de rótulos distintos em uso para um tipo de objeto (paginado). Isso não retorna linhas de atribuição de rótulos — use get para o detalhe de uma única linha.

Argumentos

Nenhum.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto para o qual listar rótulos.
• --object-ids <uuid...> — restringir a rótulos atribuídos a esses objetos (separados por espaço). Omita para pesquisar todo o tipo de objeto.
• --label-types <type...> — filtrar por tipos de rótulo (userLabel, systemLabel, internalLabel, separados por espaço). O padrão é userLabel + systemLabel.
• --filter <text> — prefixo para corresponder nomes de rótulos ( no lado do StartsWith servidor, não uma pesquisa geral de substring).
• --sort-by <expr> — classificar expressão, por exemplo name asc.
• --limit <n> — tamanho da página. O padrão é 50.
• --offset <n> — resultados a ignorar. O padrão é 0.

Exemplo

uip tm objectlabel list \
  --project-key DEMO \
  --object-type TestCase \
  --filter smo \
  --limit 50

Formato dos dados

{
  "Code": "ObjectLabelsList",
  "Data": [
    { "Name": "smoke" },
    { "Name": "smoke-test" }
  ]
}

Cada linha é apenas { "Name": "<label>" } — nenhum Id, ObjectId ou LabelType é retornado por list. Para obter os detalhes completos de uma linha de atribuição específica (incluindo seu Id), use objectlabel get.

Obtenção de rótulo de objeto uip tm

Obtém uma única linha de atribuição de rótulo por seu UUID de atribuição.

Argumentos

Nenhum.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> obrigatório) — tipo de objeto ao qual o rótulo pertence.
• --label-id <uuid> necessário) — UUID da linha de atribuição do rótulo. Este é o UUID do registro de atribuição, não um nome de rótulo.

Exemplo

uip tm objectlabel get \
  --project-key DEMO \
  --object-type TestCase \
  --label-id a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "ObjectLabelGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "f9e8d7c6-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Name": "smoke",
    "Description": "",
    "LabelType": "UserLabel"
  }
}

LabelType nessa resposta é PascalCase (UserLabel, SystemLabel, InternalLabel), mesmo que os sinalizadores de entrada --label-type/--label-types assumam a forma de aplicativo CamelCase.

adição de rótulo de objeto uip tm

Adiciona rótulos a um ou mais objetos. Dois comportamentos distintos, dependendo se --label-type é passado:

• --label-type (padrão): uma única chamada de adição em massa em todos os objetos e rótulos. Transmita --remove-other-labels para tornar esse conjunto autorizado — após adicionar, quaisquer rótulos fora do sistema nesses objetos que não estão em --labels são excluídos.
• --label-type: cada rótulo é atribuído individualmente (fazendo loop de cada objeto × par de rótulo), para que um tipo de rótulo específico possa ser gravado. --remove-other-labels é ignorado nesse modo.

Argumentos

Nenhum.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto.
• --object-ids <uuid...> (necessário) — UUIDs de objetos separados por espaço para aplicar os rótulos.
• --labels <name...> necessário) — nomes de rótulos separados por espaço a adicionar.
• --label-type <type> — tipo de rótulo (userLabel, systemLabel, internalLabel). Quando definido, muda para o caminho de atribuição por par descrito acima.
• --remove-other-labels — após adicionar, exclua quaisquer rótulos que não sejam do sistema nesses objetos não presentes --labels em. Ignorado quando --label-type está definido.

Exemplos

# Bulk add — multiple labels to multiple objects in one call
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --labels smoke regression

# With a specific label type — assigns each label individually
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --labels smoke \
  --label-type systemLabel

Formato dos dados

{
  "Code": "ObjectLabelsAdd",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 2,
    "Result": "Added"
  }
}

Quando --label-type é passado, a resposta o inclui:

{
  "Code": "ObjectLabelsAdd",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 1,
    "LabelType": "systemLabel",
    "Result": "Added"
  }
}

remoção de rótulo de objeto do uip tm

Remova rótulos de um ou mais objetos. Esta é uma operação destrutiva — requer -y, --yes; a CLI nunca solicita. Forneça --labels para remover rótulos específicos ou --remove-all-labels para limpar todos os rótulos fora do sistema dos objetos especificados — os dois são mutuamente exclusivos.

Argumentos

Nenhum.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto.
• --object-ids <uuid...> (necessário) — UUIDs de objeto separados por espaço.
• --labels <name...> — nomes de rótulos separados por espaço a remover. Obrigatório, a menos que --remove-all-labels esteja definido.
• --remove-all-labels — limpe todos os rótulos que não são do sistema nos objetos listados. Mutualmente exclusivo com --labels.
• -y, --yes — confirme esta operação irreversível. Necessário — a CLI nunca solicita.

Exemplos

# remove specific labels
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --labels regression \
  --yes

# clear every non-system label
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --remove-all-labels \
  --yes

Formato dos dados

{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 1,
    "Result": "Removed"
  }
}

Com --remove-all-labels, a resposta relata RemoveAllLabels em vez de LabelCount, e Result é AllRemoved:

{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "RemoveAllLabels": true,
    "Result": "AllRemoved"
  }
}

Relacionado

• requisitos — os requisitos podem carregar rótulos de objeto.
• campo personalizado — um mecanismo de rótulo separado (customfield label) para valores de campos personalizados do tipo Rótulo; distinta das tags de forma livre de objectlabel.

Veja também

• Visão geral do Test Manager