Sobre LuaRocks

Imagine que você desenvolveu uma biblioteca lua. Atualmente para qualquer programador usar essa biblioteca é necessário fazer o download dos arquivos fonte, copiá-los para pasta correta e finalmente usá-la em alguma outra aplicação. Dependendo da biblioteca isso pode ser complicado, além disso quando existirem duas ou mais versões diferentes a manutenção dessas versões será muito complicada. O objetivo do LuaRocks é justamente facilitar a instalação e a manutenção de bibliotecas lua fornecendo, inclusive, suporte à versões diferentes de uma mesma biblioteca.

O programa LuaRocks busca rocks de um tipo de repositório -- repositório de rocks -- e instala-os em um outro tipo de repositório -- árvore de instalação. Um repositório de rocks é um diretório que contêm rocks e/ou rockspecs, e um arquivo manifest que cataloga os rocks contidos nele.

O LuaRocks pode ser configurado para usar múltiplas árvores de instalação e múltiplos servidores de rocks, ambos abordados com mais detalhes abaixo.

Publicar um repositório como um servidor de rocks consiste em criar um diretório que contém rocks e um arquivo manifest e disponibilizá-lo online.

O LuaRocks possui 2 comandos principais luarocks e luarocks-admin.

Repositórios e Árvores de rocks

Como dito anteriormente existem 2 tipos de repositórios, o repositório de rocks e a árvore de instalação.

• Repositório de rocks:
  • Os repositórios de rocks tem como objetivo fornecer pacotes (rocks) fechados para que a devida instalação seja feita. Esses pacotes podem ser rocks ou rockspecs, e podem ficar em URLs (HTTP ou ftp) remotas, ou em diretórios locais.
  • No nosso caso usamos o servidor principal (luarocks.org) como repositório de rocks default, e caso não seja encontrado o pacote especificado a busca é feita no alfa:/var/www/rocks. Isso ocorre devido a ordem em que os servidores de rocks se encontram no arquivo de configuração, que pode ser visto abaixo.
  • Um detalhe importante é que temos informções confidenciais que não devem ser disponibilizadas para terceiros, portanto, o acesso ao nosso servidor de rocks é restrito. Sendo, IP para o acesso da máquina de produção (luarocks não oferece opção de senha) e senha para o acesso de qualquer outro IP usando o borwser.
  • Verifique os rocks disponíveis no nosso repositório.


• Árvore de rocks:
  • As árvores de instalação tem como objetivo fornecer bibliotecas para aplicações. Essas bibliotecas tem que estar disponíveis no repositório de rocks, daonde serão baixadas e instaladas na árvore antes do uso. Portanto, as árvores contém somente rocks desempacotadas (instaladas e prontas para uso), e são sempre locais.
  • Por default cada usuário tem sua própria árvore de instalação, inclusive o root. Sendo a árvore do root comum a todos para uso dos pacotes, não podendo ser feita instalação. Note que as árvores de instalação também seguem uma hierarquia definida pelo arquivo de configuração.
  • Uso dos pacotes (require"xpto"):
    • Primeiro lê do ~/.luarocks e caso não encontre lê do /usr/local. Ou seja, caso o usuário que está fazendo o require não tenha uma árvore própria usa-se a do root. Nossos sistemas, e qualquer outra aplicação que use usuários "fantasmas" (www-data, nobody, etc.) usará os pacotes do root. Com isso podemos desenvolver e testar novos pacotes sem interferir no resto do sistema. Veja a seção Desenvolvendo com LuaRocks para mais detalhes.
  • Instalação de rocks (luarocks install xpto):
    • Instala na árvore do usuário que digitou o pacote xpto. O uso de 'sudo' instala na árvore do root e portanto disponibiliza para todos.
  • Arquivo de configuração (/usr/local/etc/luarocks/config.lua):

    rocks_servers = { --repositório de rocks
    	[[http://luarocks.org/repositories/rocks]],
    	[[/var/www/rocks]],
    	[[http://luarocks.giga.puc-rio.br/]]
    }
    
    	rocks_trees = { --árvore de instalação
    	home..[[/.luarocks]],
    	[[/home/ccpa-auto/luarocks]],
    	home..[[/.luarocks]],
    	[[/usr/local]]
    }

Criando um novo rock

Abaixo segue uma idéia geral de como fazê-lo, para maiores detalhes clique aqui.

Imagine que você desenvolveu uma biblioteca lua chamada mylib e que você deseja disponibilizá-la para a comunidade pelo LuaRocks. Tudo que você precisa fazer é criar um rockspec com o nome mylib-versao.rockspec, onde versao = X.Y.Z-W.

• X é a versão principal da sua biblioteca e só muda quando a interface da mesma mudar.
• Y é a sub-versão da biblioteca e muda a medida que a implementação mudar.
• Z é a versão de bug-fix, e muda a cada bug que for corrigido.
• W é a versão do rockspec, e muda a cada novo rockspec para mesma versão.

O rockspec deve ser copiado para a raiz do projeto, por exemplo o comando "ls /home/pablomusa/mylib/" gera:

mylib-1.0.0-0.rockspec src/ tests/ CVS/

Com a biblioteca pronta e o rockspec feito, precisamos criar o pacote (rock) e publicá-lo. Para criar o pacote devemos executar os seguintes comandos a partir do diretório raiz do projeto:

• Criar Pacote:
  • # Instala na sua árvore de instalacao o pacote indicado. * Verificar se teve erro no rockspec e corrigi-lo.

    luarocks make mylib-1.0.0-0.rockspec

  • # Gera o pacote .rock do módulo e versão indicados.

    luarocks pack mylib 1.0.0-0

    • * O comando make é equivalente ao 'luarocks install <pacote>', mas, nesse caso o pacote ainda não foi publicado como rock e está na pasta corrente.
    • ** O comando pack, por baixo dos panos, transforma a instalacao que acabamos de fazer com o comando make em um arquivo zipado com extensão .all.rock.
• Publicar Pacote:

  mv mylib-1.0.0-0.all.rock <pasta_publicacao> # adiciona o pacote ao repositorio de rocks
  luarocks-admin make_manifest <pasta_publicacao> # atualiza o arquivo de mapeamento de rocks publicados

• Sintra:

  luarocks make sintra-2.0.0-0.rockspec # instala no seu repositorio proprio de rocks o pacote sintra
  luarocks pack sintra 2.0.0-0 # gera o arquivo sintra-2.0.0-0.all.rock a partir da instalacao local
  mv sintra-2.0.0-0.all.rock /var/www/rocks/ # move o arquivo .rock para o nosso servidor de rocks
  luarocks-admin make_manifest /var/www/rocks # atualiza o nosso servidor de rocks
  

  *** O cvs do sintra já contém o script 'publica.sh' que faz esse passo a passo automaticamente.

Desenvolvendo com LuaRocks

Os pacotes instaláveis via LuaRocks devem ser projetos no CVS, portanto o desenvolvimento dever ser feito localmente na sua conta. - explicar como instalar localmente e as vantagens de fazer isso

• Faça checkout do projeto usando uma das opções abaixo:

  voce@alfa:~$ cvs checkout -P <projeto> # caso ainda não possua uma cópia local
  voce@alfa:~$ cvs co -dP <projeto>
  

  ** Problema com cvs veja ???? para configuração de ambiente.
• Faça as correções ou inovações que desejar
• Atualize o rockspec e a versão do mesmo. O número da versão deve ser alterado tanto dentro do arquivo (no campo version) quanto no nome do arquivo .rockspec. Se os números não estiverem iguais, haverá um erro na instalação.

  voce@alfa:~/projeto$ mv <projeto>-<versão>.rockspec <projeto>-<nova versão>.rockspec
  voce@alfa:~/projeto$ cvs remove <projeto>-<versão>.rockspec
  voce@alfa:~/projeto$ cvs add <projeto>-<nova versão>.rockspec
  voce@alfa:~/projeto$ cvs commit
  

• Faça a instalação local (a nova versão vai ficar disponível apenas para o seu usuário):

  voce@alfa:~/projeto$ instala_rock.sh <projeto> <versão>
  

• TESTE !!!
  Alguns teste só funcionam na produção então é mais trabalhoso de testar, mas dá para fazer de uma forma segura:

  voce@alfa:~$ ssh prod
  voce@prod:~$ luarocks install <projeto> # instala na sua árvore de rocks
  voce@prod:~$ lua -lluarocks.require ~/.luarocks/rocks/<projeto>/<versão>/testes/<arquivo de teste>.lua
  

• Rotule a versão antes de fazer a instalação no sistema:

  voce@alfa:~/projeto$ cvs tag v?_?_?
  voce@alfa:~/projeto$ luarocks --tree=/home/ccpa-auto/luarocks install <projeto>