Sobre a Configuração de um Pipeline de CI/CD

Primeiro, obtenha sua API pronta. Você deve definir pelo menos seus pontos finais e fazer download do scaffold que o OMC gera para você. O scaffold representa uma aplicação mínima que você pode usar para certificar-se de que seu processo CI/CD está funcionando corretamente antes de avançar e gravar e testar o código da API personalizada.

Quando sua API está pronta e você pode enviar alterações com sucesso ao repositório Git em seu projeto Cloud Service do Desenvolvedor, é hora de configurar CI/CD para o projeto.

Configure a API no Oracle Mobile Hub

Crie um scaffold de API definindo os pontos finais REST aos quais suas aplicações se conectam. Depois de concluir o scaffold, você pode fazer download de sua definição para usar como ponto de partida para seu código de API.

Ao definir os métodos HTTP para seus pontos finais, você tem a opção de adicionar respostas de amostra. Fala estritamente, as respostas de amostra não são necessárias porque você estará escrevendo código posteriormente que ofereça respostas reais. No entanto, talvez você queira inserir algumas respostas de amostra para testar a API antes que seu código personalizado esteja pronto.

  1. Efetue log-in no Oracle Mobile Hub e abra o painel de navegação.
  2. Na seção Aplicações do painel de navegação, clique em APIs .
  3. Clique em Nova API e, no menu que é aberto, clique em API.
    A janela Nova API é aberta.
  4. No campo Nome para Exibição da API e no campo Nome da API , informe um nome adequado para sua API.
  5. No campo Descrição Curta , informe uma descrição apropriada.
  6. Se você tiver um documento RAML para sua API, faça upload dele aqui.
  7. Clique em Criar e a página da sua nova API será aberta.
  8. Adicionar recursos HTTP. Se você tiver feito upload de um documento RAML, poderá ignorar esta etapa.
    1. Clique em Pontos Finais e, em seguida, clique em Novo Recurso para criar o primeiro ponto final e definir seus métodos HTTP.
    2. Continue definindo os pontos finais e os métodos HTTP da sua API até que todos os pontos finais sejam definidos.
  9. Clique em Salvar.

Configurar o Backend

Crie o backend que sua API usará. O backend roteia solicitações de seus aplicativos para a API e fornece serviços de autenticação.

  1. No painel de navegação do Oracle Mobile Hub , clique em Backends , que abre a página Backends .
  2. Clique em Novo Backend e, na janela que é aberta, informe um nome adequado no campo Nome e, em seguida, clique em Criar .
    A página de configuração de backend será aberta. Ela tem seu próprio painel de navegação, que é aberto na página Definições .
  3. No painel de navegação da página de configuração, clique em APIs e, na página que é aberta, clique em Selecionar APIs , que abre o Catálogo de APIs.
  4. No catálogo, localize o cartão da API que você criou e clique no botão + . Isso associa essa API a este backend.

Informações sobre Backend e Detalhes da Instância de Registro

Registre as informações de que você precisará ao configurar as ferramentas de desenvolvimento.

As informações são usadas em um arquivo chamado toolsConfig.json e são necessárias para autenticação. Ele permite que um script se conecte ao Oracle Mobile Hub e entregue artefatos de código a ele.

  1. No painel de navegação do Oracle Mobile Hub , clique em Backends , que abre a página Backends .
  2. Selecione seu backend e clique em Abrir .
  3. No painel de navegação, clique em Definições .
  4. Registre as seguintes informações e copie-as em um arquivo de texto ou em outro lugar onde você pode recuperá-las facilmente mais tarde:
    • ID do Cliente
    • Segredo do Cliente
    • ID do Backend
    • Nome do Backend
    • Versão do Backend
    • Chave Anônima
  5. No painel de navegação, clique em Desenvolvimento para abrir a página principal e, em seguida, clique em Detalhes da Instância para abrir o painel Detalhes da Instância .
  6. Registre as seguintes informações e mantenha-as com as informações de backend que você registrou em uma etapa anterior:
    • ID do Cliente do Aplicativo do Membro da Equipe
    • Segredo do Cliente do Aplicativo do Membro da Equipe

Configurar um Projeto no Oracle Developer Cloud Service

Crie um projeto que inclua um repositório Git. Posteriormente, você configurará o projeto para executar um build sempre que submeter um commit ao repositório.

Criar um Projeto

Crie um projeto que inclua um repositório Git.

  1. Efetue log-in na console do Oracle Developer Cloud Service e clique em Novo Projeto .
  2. Na página Detalhes do Projeto , informe um nome para seu projeto e clique em Próximo .
  3. Na página Modelo , selecione Repositório Inicial e clique em Próximo .
  4. Na página Propriedades do Projeto , aceite os valores padrão e clique em Finalizar para iniciar o processo de provisionamento.

Depois que o projeto é fornecido, sua tela deve ser semelhante à seguinte imagem:


A página de resumo do projeto

Clonar e Configurar o Repositório Git

Clona o repositório para seu sistema de desenvolvimento local.

  1. Efetue log-in no Oracle Developer Cloud Service e navegue até a página do projeto.
  2. Copie o endereço HTTP do campo para o repositório do Git.
  3. Abra uma janela de terminal (no Linux ou Mac) ou o terminal do Git Bash (no Windows) e crie um novo diretório em um local conveniente no disco rígido. Use um nome para o diretório apropriado para seu projeto.
     mkdir <your-directory-name>
  4. Altere para o diretório e clone o repositório, substituindo o endereço do repositório na amostra por sua conta.
    cd <your-directory-name>
    git clone <your-repo-url>

    Quando for solicitada uma senha, use a senha que você usa para fazer log-in no Oracle Developer Cloud Service .

  5. Mude para o diretório que foi criado pelo processo de clonagem.
    cd <your-directory-name>
  6. Defina seu nome e endereço de e-mail para este projeto e configure o Git para armazenar suas credenciais.
    git config user.name "<your-name>"
    git config user.email "<your-email-address>"
    git config credential.helper store

Criar um Novo Job de Build

Crie um job que será executado sempre que você enviar um código para o repositório do Git do projeto.

  1. Efetue log-in no Oracle Developer Cloud Service e navegue até a página do projeto.
  2. No painel de navegação, clique em Criar e, na página aberta, clique em Novo Job .
  3. Informe um nome e selecione um modelo de software; em seguida, clique em Criar Job .
  4. Clique em Adicionar Controle de Origem e selecione Git .
  5. Na lista drop-down Repositório , selecione o repositório Git que você deseja usar.
  6. Opcional: Se você for o único desenvolvedor que envia o código para o repositório, selecione Executar automaticamente a construção no commit do SCM.

    Se várias pessoas estiverem trabalhando no projeto e enviando o código para o repositório, não selecione esta opção. Você pode configurar um trigger de polling do SCM, que você pode fazer após finalizar a criação do job de build.

  7. Clique em Salvar.

Configurar o Trigger de Sondagem do SCM

Você pode configurar um questionário que verifica se há alterações no repositório do Git em uma programação definida por você. Se forem detectadas alterações, um build será iniciado.

Se você for o único desenvolvedor que envia um código para o repositório, é provável que um build imediato seja apropriado. No entanto, quando várias pessoas enviarão código, você poderá configurar um trigger de sondagem que verifica periodicamente se há alterações no repositório antes de iniciar um build.

Para configurar o trigger de polling do SCM, use o formato crontab para definir uma programação de polling. Se você não estiver familiarizado com o formato crontab, poderá usar a interface gráfica para criar o agendamento.

A programação default é a cada 30 minutos, representada por 0/30 * * * *. Para definir a programação para ser executada em 30 minutos após a hora a cada hora, use 30 * * * *.

  1. Efetue log-in no console do Oracle Developer Cloud Service e abra seu projeto.
  2. No painel de navegação, clique em Criar e selecione o build para o qual deseja definir os parâmetros.
    A página Definições do Build é aberta.
  3. Clique em Configurar.
    A página Configuração do Job é aberta.
  4. Clique no ícone de engrenagem O ícone de definições é semelhante a um par de engrenagens. e, em seguida, clique em Triggers para abrir o painel Configurar Triggers do Build .
  5. Clique na lista drop-down Adicionar Trigger e selecione Trigger de Sondagem SCM.
  6. Defina a programação e clique em Salvar .

Configurar os Parâmetros de Build

Configure um parâmetro de string e um parâmetro de senha para manter o nome do usuário e a senha da sua conta do Oracle Mobile Hub .

Mantenha o controle dos nomes desses parâmetros porque você precisará deles posteriormente ao configurar a ferramenta do desenvolvedor.

  1. Efetue log-in no console do Oracle Developer Cloud Service e abra seu projeto.
  2. No painel de navegação, clique em Criar e selecione o build para o qual deseja definir os parâmetros.
    A página Definições do Build é aberta.
  3. Clique em Configurar.
    A página Configuração do Job é aberta.
  4. Clique na guia Parâmetros de Build .
  5. Clique no menu suspenso Adicionar Parâmetro de Build e selecione Parâmetro de String.
  6. Informe um nome para o parâmetro de nome de usuário. Por exemplo,devUser.
  7. No campo Valor Padrão, informe seu nome de usuário do Oracle Mobile Hub . Por exemplo, samir.developer@example.com.
  8. Clique no menu suspenso Adicionar Parâmetro de Build e selecione Parâmetro de Senha.
  9. Informe um nome para o parâmetro de senha, como o devPassword .
  10. No campo Valor Padrão , informe a senha do nome do usuário do Oracle Mobile Hub .
  11. Clique em Salvar.

Configurar o Unix Shell Builder

O shell builder é um script Bash que é executado no sistema de build sempre que um build é acionado. Ele instala dependências e entrega seu código para o Oracle Mobile Hub .

O script é executado com a origem do repositório Git que você configurou quando criou o projeto no Oracle Developer Cloud Service . Observe que, se o script falhar em qualquer ponto, ele sairá com um erro e nenhum código será implantado.

  1. Efetue log-in no console do Oracle Developer Cloud Service e abra seu projeto.
  2. No painel de navegação, clique em Criar e selecione o build para o qual deseja definir os parâmetros.
    A página Definições do Build é aberta.
  3. Clique em Configurar.
    A página Configuração do Job é aberta.
  4. Clique na guia Builders .
  5. Clique na lista drop-down Adicionar Builder e selecione Unix Shell Builder .
  6. No campo Script , informe o seguinte script:
    export NODE_PATH=node-configurations/8.9/node_modules
    npm install
    cd omce-tools
    npm install
    cd node-configurations/8.9
    npm install
    cd ../..
    node omce-deploy ../toolsConfig.json -u $devUser -p $devPassword
  7. Clique em Salvar.

Download de Scaffold JavaScript

Depois de criar o esqueleto da API, o sistema criará um scaffold para o código da API que você pode fazer download em um arquivo zip.

O scaffold contém a estrutura inicial e os arquivos da implementação da API, que você usará como ponto de partida para suas personalizações. Você precisa extrair os arquivos e colocá-los em seu diretório de trabalho.

  1. No Oracle Mobile Hub , abra a API para a qual você deseja criar scaffold.
  2. No painel de navegação da API, clique em Implementação .
  3. Clique em JavaScript Scaffold , o que faz download do arquivo scaffold para seu computador.
  4. Extraia o arquivo package.json, toolsConfig.json e o arquivo .js da API para seu diretório de trabalho. É o mesmo diretório que foi criado quando você clonou o repositório do Git e contém o diretório .git.

Instalar e Configurar a Ferramenta de Desenvolvimento

O Oracle oferece ferramentas para fazer upload de implementações de API personalizadas para o Oracle Mobile Hub pela linha de comando. Adicione as ferramentas ao seu repositório Git para que elas fiquem disponíveis para seu script de build no Oracle Developer Cloud Service .

As ferramentas fazem parte de um download que também contém uma API Oracle Mobile Hub que você pode usar para testar e depurar suas implementações de API personalizadas no sistema de desenvolvimento. A API não é necessária para usar o pipeline CI/CD. Consulte o arquivo readme dentro do diretório omce-tools para obter instruções sobre como usar a API, que é chamada OracleMobileAPI.

As ferramentas suportam duas versões de Node.js: 6.10.0 e 8.9.x. Nesse procedimento, presume-se que você esteja usando a versão 8.9.4 ou superior.

Para instalar e configurar as ferramentas:

  1. Vá para https://www.oracle.com/technetwork/topics/cloud/downloads/amce-downloads-4478270.html e faça download das Ferramentas de Teste de Código Personalizado versão 18.3.1 ou mais recente. Observe que os nomes de arquivo nessa página ainda seguem os nomes de produtos legados, mas o código que eles contêm está atualizado com a versão mais recente. Da mesma forma para os nomes das ferramentas dentro do download.
  2. Abra o arquivo que você transferiu por download e extraia o conteúdo do diretório omce-tools/omce-tools para seu diretório de trabalho, o diretório que possui .git nele. Por exemplo, se o diretório de trabalho for test-project, extraia o conteúdo de omce-tools/omce-tools para test-project/omce-tools.
  3. Instale a configuração do Nó: altere para o diretório omce-tools/node-configurations/8.9 e execute npm install.
  4. Instale o omce-tools no seu sistema: altere para o diretório omce-tools e execute npm install -g.
  5. Crie uma variável de ambiente chamada NODE_PATH e defina-a como node-configurations/8.9/node_modules.
  6. Verifique se as ferramentas estão instaladas corretamente. No diretório omce-tools, execute node omce-test --version. O resultado deve ser 18.3.1.
  7. Atualize o toolsConfig.json. Quando você faz download do scaffold, ele incluiu o arquivo de configuração toolsConfig.json. Use as informações que você registrou do backend para substituir o texto do placeholder em toolsConfig.json.