Objetivo

Este guia tem o objetivo de apresentar, de maneira resumida, informações sobre o processo de homologação de soluções desenvolvidas por parceiros e disponibilização na fluig Store.

Visão Geral

Após finalizar o desenvolvimento e testes do seu app/componente, é o momento de enviá-lo para o quality assurance (QA). Considerando que o checklist para cada tipo de app já foi implementado conforme este quadro, o próximo passo é adaptar esse app/componente para o QA.

Esse documento é um checklist básico de instruções que você deve seguir para agilizar o processo de QA do seu app. Seguindo essas instruções, a inspeção do seu app pelos analistas será mais fácil e rápida e você terá o resultado para publicá-lo na loja ou fazer os ajustes necessários.

Para quem já é um parceiro fluig Store, acesse o documento completo do check-list de QA no Portal da fluig Store.

Finalizado o processo, o status da aprovação será enviado através de um relatório como anexo no próprio processo.

Dúvidas básicas

1. Adequação e clean code

• Widgets, Layouts e outros componentes do fluig já possuem uma estrutura padrão com pastas pré-definidas (css, js, images). Mantenha essa estrutura organizada.

• Referenciar todo e qualquer biblioteca de JS no arquivo application.info.

• Não deixe arquivos que não estão sendo utilizados dentro do componente. Se houver, remova-os antes de enviar para o QA.

• O fluig já inclui algumas das bibliotecas mais utilizadas, como jQuery, jQuery UI e o próprio fluig Style Guide. Não é necessário adicioná-las novamente.

• Internacionalização: Ao criar qualquer label, avisos, títulos e demais informações, é necessário internacionalizar os textos.

• Utilizar a verificação de licença através da API de Licença.

2. Adaptar componente para a fluig Store

Para a fluig Store, padronizamos a estrutura que o componente deve ser desenvolvido, cujo objetivo também é acelerar o processo de QA, além de formatá-los para o download e instalação por meio da plataforma fluig de forma simples e rápida (Item da Store). O componente deve seguir os padrões demonstrados no exemplo Sample Component e seguir as etapas abaixo: 

• O arquivo final deve ser do tipo .ear. O pacote server é o responsável por criar esse arquivo .ear.

• É essencial que o app/componente tenha o arquivo component.xml. Ele contém o componentCode, que é o código do seu componente dentro da fluig Store e no fluig do cliente que será instalado. Lembre-se que esse código é geral para todos os apps na fluig Store, ou seja, não pode existir mais de um app/componente com o mesmo componentCode.

• Recomendamos a utilização do pages.xml, onde é possível criar uma página dedicada especialmente para o seu app/component, além de um ícone próprio.

Para mais detalhes técnicos, acesse o link do componente e leia o README.md.

3. Fazer o upload do código no git.fluig.com

Assim que o app/componente estiver adaptado para a fluig Store, o próximo passo é subir o código no repositório Git fluig. Nesse momento, você já deverá possuir um repositório exclusivo para o seu app/componente e um usuário e senha. Caso não tenha ainda, por favor entrar em contato através do Portal fluig Store.

Siga essas instruções na ordem ao subir o código:

1. A partir da master crie uma nova branch. (Fique à vontade para criar o nome. Recomendamos utilizar AAAA-MM-DD, por exemplo: 2018-04-10).

2. Efetue o checkout dessa nova branch e faça o commit e push do código.

3. Em seguida, abra um Pull Request dessa branch para a master e selecione alguma pessoa responsável.

4. Documentação técnica

Juntamente com o código solicitamos também uma documentação técnica, contendo informações e detalhes mais técnicos do app/componente. Os itens a seguir são fundamentais:

• Quais cards do fluig estão sendo utilizado. Ex.: ECM e BPM. Isso facilita no momento de selecionar os especialistas que vão analisar o código, separando apenas os analistas que conhecem de ECM e BPM.

• Visão geral da arquitetura do componente.

• Para apps/componentes híbridos, ou seja, com acesso externos:

• Caso haja acesso a serviços externos, do tipo API’s Rest, WebServices SOAP, etc, crie uma breve descrição.

• Autenticação dos serviços externos.

• Integridade dos dados.

• Backup.

• Multitenancy.

5. Publicação do app na Store (Vamos vender!)

Após o envio da documentação, o QA do app/componente está apto a iniciar as análises e bateria de testes. Assim que finalizada esta etapa, será enviado o resultado por meio de um relatório, que indicará se o app está aprovado ou não.

Caso aprovado, o app já estará pronto para submissão na fluig Store, faltando apenas pequenos detalhes. Nesta etapa, precisamos fazer o upload do app para o repositório de arquivos. Essa submissão será realizada através de um processo no Portal fluig Store, juntamente do preenchimento de um formulário, com nome, descrição, e-mail de suporte, landing page  e outras informações.

Caso não seja aprovado, o relatório irá detalhar os motivos e quais ajustes deverão ser feitos. Os itens estarão identificados da seguinte maneira:

• Alteração necessária: impede a publicação do app na fluig Store. Pode ser mau funcionamento, documentação insuficiente ou algo que interfira negativamente no uso do app.

• Alteração recomendada: itens que não impedem o uso do app mas necessitam de análise para possível adequação. Não impede a publicação na fluig Store na versão em que o item foi identificado, mas pode ser cobrado futuramente, em uma nova versão do app.

• Sugestão: são oportunidades de evolução do app, para torná-lo ainda melhor. Não impede a publicação na fluig Store.