Skip to content

Plugin tests
Compare
Choose a tag to compare
@MarianaPacheco1 MarianaPacheco1 released this 24 Nov 13:23
EDP.Feature1
8ffd311
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
This release note is written in English and Portuguese, scroll to the end to access both languages.
Esta release note está escrita em Inglês e Português, role a página até o final para ter acesso às duas linguagens.

Content creators now have the ability to create plugin test cases in the CLI.

What is Plugin testing and its benefits?

Content creators have the possibility to test the plugins created to validate the generated templates. The content creator can create test cases exclusively for the plugin, where it is possible to insert the project content in the destination folder, simulating the application of the plugin in projects that were not created with StackSpot, thus ensuring complete coverage of the generated templates.

How it works?

To add test cases to an existing plugin, the content creator must follow the following steps:
1 – Create a folder in the root of the plugin;
2 - Create a subfolder that contains the name of the test scenario;
3 - Create the following items in the subfolder:

  • Expected folder: folder that contains the expected files to validate the plugin application.
  • Target folder: folder containing an app/infra, in which the plugin will be applied.
  • test-case.yaml file: file that contains the test case manifest (inputs, inputs-envs, required connection, generated connection)

4 - Run the test cases with the stk test plugin command.

You can run the tests in the following ways:

  • stk test plugin: will run all test scenarios in application and deployment, with the exception of skipped scenarios.
  • stk test plugin: will run the test scenario containing the entered name.
  • stk test plugin --mode apply: Will run all test scenarios in apply mode, with the exception of skipped scenarios.
  • stk test plugin --mode deploy: Will run all test scenarios in deploy mode, with the exception of skipped scenarios.

Supporting content

Documentation

Os criadores de conteúdo agora têm a capacidade de criar casos de testes para plugin na CLI.

O que é Plugin tests e seus benefícios?

Os criadores de conteúdo tem a possibilidade de testar os plugins criados para validar os templates gerados. O criador de conteúdo consegue criar casos de teste exclusivamente para plugin, onde é possível inserir o conteúdo do projeto na pasta de destino, simulando a aplicação do plugin em projetos que também não foram criados com StackSpot, garantindo assim cobertura completa dos templates gerados.

Como funciona?

Para adicionar casos de teste a um plugin existente, o criador de conteúdo deve seguir os seguintes passos:
1 – Crie uma pasta na raiz do plugin;
2 - Crie uma subpasta que contenha o nome do cenário de teste;
3 - Crie os seguintes itens na subpasta:

  • Expected folder: pasta que contém os arquivos esperados para validar a aplicação do plugin.
  • Target folder: pasta que contém um app/infra, na qual o plugin será aplicado.
  • Arquivo test-case.yaml: arquivo que contém o manifesto do caso de teste (entradas, inputs-envs, connections requeridas, connections geradas)

4 - Execute os casos de teste com o comando stk test plugin.

Você pode executar os testes das seguintes maneiras:

  • stk test plugin: executará todos os cenários de teste em aplicação e implantação, com exceção de cenários ignorados.
  • stk test plugin: executará o cenário de teste que contém o nome inserido.
  • stk test plugin --mode apply: Executará todos os cenários de teste no modo de aplicação, com exceção dos cenários ignorados.
  • stk test plugin --mode deploy: Executará todos os cenários de teste no modo de implantação, com exceção dos cenários ignorados.

Conteúdos de apoio

Documentação

Assets 2
Loading