Documentação Plataforma Guigoh e Projetos Relacionados

Transcrição

1 Documentação Plataforma Guigoh e Projetos Relacionados 1

2 Índice Descrição...3 Arquitetura...5 Inicialização...7 Considerações Importantes...9 Perguntas Frequentes

3 Descrição javadoc ER Guigoh (antigo teobaldo2) O "guigoh, reúne funcionalidades voltadas à promover processos colaborativos de construção de conhecimento. Entre as funcionalidades do projeto existe o Doc que é uma ferramenta que consiste em um repositório de documentos que são disponibilizados na rede para que possam ser alterados colaborativamente. As demais ferramentas do Guigoh estão em projetos independentes que serão descritos logo abaixo. javadoc mandril core javadoc mandril RTS ER mandril core Projeto Mandril O Mandril é um ambiente para publicação de documentos. Neste ambiente, os documentos passam por um processo de revisão antes de serem disponibilizados para acesso do público. O Mandril foi separado em dois projetos: mandril core e mandril web*. Ambos estão liberados em código aberto sob a licença GPL no repositório kenai. O projeto mandril web* é dependente da biblioteca mandril core e contém toda a impletementação que atende a necessidade do cliente, é nele que é especificado qual será o tipo de documento revisável(artigo, tecnologia social etc), como será o processo de revisão e a interface personalizada do cliente *Projeto de customização para cada cliente. Ex.: mandril rts javadoc ER Primata O Primata é o núcleo de redes sociais do Guigoh, contendo a base de usuários, o relacionamento entre usuários(contatos), comunidades, controle de mensagens instantâneas etc. 3

4 javadoc Primata VOS É uma biblioteca que visa facilitar a obtenção e exposição de informações por serviços REST entre projetos. javadoc AccountService javadoc AuthHelper AccountService É o projeto responsável pelo serviço de autenticação. O Auth Helper é uma biblioteca obrigatória para os projetos que desejam utilizar o serviço de autenticação 'AccountService'. javadoc Muriqui Conferência A conferencia é uma ferramenta que possui um chat, e está estruturado para receber um voip e o whiteboard na proxima versão. 4

5 Arquitetura Diagrama de arquitetura entre projetos Considerações Os projetos Web seguem o modelo arquitetural REST (Representational State Transfer) que disponibiliza serviços por meio do protocolo HTTP, ou seja, estando autenticado, com uma simples URL você obtém as informações que deseja. AccountService Para fazer a autenticação do usuário este projeto utiliza um cookie que pode ser retransmitido pelas ferramentas para fazer a propagação das credenciais. Ou seja, quando um usuário loga no sistema, ele é automaticamente logado em todas as ferramentas que utilizam o AccountService como servidor de autenticação. Este projeto utiliza a Segurança Declarativa do Application Server(atualmente através o JBOSS). A base de dados para usuarios usada é a do primata. 5

6 Também contém a página de login que é utilizada pelos projetos, para fazer a alteração de interface é só alterar estilos CSS. Os projetos que participam da autenticação por meio do projeto AccountService são obrigados a importar a biblioteca AuthHelper e fazer as configurações necessárias. Primata É na base de dados do primata que ficam as informações de usuários e comunidades. Ele passa essas informações para os outros projetos através dos serviços REST. Para facilitar o acesso as suas informações por código java, a biblioteca primata vos pode ser utilizada. Uma das funcionalidades é a troca de mensagens instantâneas por meio do protocolo XMPP. O framework que usa este protocolo e é utilizado pelo Primata é o 'Smack'. O servidor que gerencia o envio e recebimento de informações via XMPP é o 'Openfire' que deverá ser inicializado antes do deploy da aplicação ser efetuado. Muriqui Nessa primeira versão o muriqui possui apenas um chat e esta adaptado para receber um voip e um whiteboard. Como todos os outros projetos, ele utiliza a autenticação do AccountService. Um detalhe é que o timezone das datas de inicio e fim das conferências são zerados ao serem salvos no banco de dados e adaptados para sua localização no momento da exibição na tela, para que os usuários de países distintos acessem a conferência no horário correto. Mandril web O mandril utiliza o projeto mandril core que contém as classes que caracterizam um ambiente de publicação. Esse projeto também utiliza a autenticação com o AccountService. No ambiente de testes como os dois projetos (Mandril Core e Mandril Web) é utilizado a mesma base de dados, assim o projeto Mandril Web herda a massa de dados de teste do Mandril Core e altera para as suas necessidades. No Projeto Mandril core tem uma implementação 'exemplo' do documento a ser revisado, que é a classe 'DefaultReviewableImpl'. Um exemplo de como é feito a substituição desta implementação default e a ligação dela com a aplicação e o banco de dados pode ser vista na classe 'MandrilContextListener' no projeto 6

7 OpenSource 'Mandril RTS'. Guigoh O guigoh acessa todos os outros projetos web, integrando suas funcionalidades em um só ambiente. Ele possui sua própria base de dados. E como os outros, ele utiliza a autenticação do AccountService. Inicialização Requisitos: JBoss 4.2.x, java 5, postgresql 7 ou +, openfire 3.5.2*, Netbeans IDE(de preferência 6.8 ou +, pela minimização de bugs no Mercurial), Mercurial, CVS(caso seja ambiente de desenvolvimento o netbeans já tem) Configurar o pg_hba.conf do postgresql (após realizar a configuração reiniciar o postgresql): # "local" is for Unix domain socket connections only local all all trust # IPv4 local connections: host all all /32 trust # IPv6 local connections: host all all::1/128 md5 *baixar o openfire e substituir o arquivo conf/openfire.xml pelo o encontrado no projeto Primata conf/init/openfire.xml. Configurar projetos: Guigoh Baixar o guigoh utilizando o cvs no endereço: :ext:username@ipti.org.br:/cvsroot/teobaldo2 Criar um usuário e o banco de dados no postgresql: Windows: createuser U postgres guigoh createdb O guigoh U postgres E UTF 8 guigoh Linux: sudo su postgres createuser guigoh createdb O guigoh E UTF 8 guigoh Configurar o aquivo teobaldo2.properties: Indicar o caminho do diretorio de armazenamento de arquivos 7

8 (teo2.data.dir). Configurar outras properties quando for necessário. Primata Baixar o fonte utilizando o mercurial no endereço: nestes fontes virão o conjunto de projetos: primata, primata vos, AuthHelper e AccountService Criar um usuário e o banco de dados no postgresql: Windows: createuser U postgres primata createdb O primata U postgres E UTF 8 primata Linux: createuser primata createdb O primata E UTF 8 primata Configurar o aquivo primata.properties: Indicar o caminho do diretorio de armazenamento de arquivos (primata.data.dir). Indicar o caminho do jboss (primata.jboss42x.path). Configurar outras properties quando for necessário. *Rodar a target ant init jboss config no arquivo build jboss4.2.x.xml Inicialize o servidor Openfire e acesse no browser o endereço ' logue no openfire, vá na opção de propriedades do servidor e adicione propriedade 'xmpp.domain' e o valor 'localhost' Mandril Baixar o fonte do mandril core utilizando o mercurial no endereço: Baixar o fonte do web da RTS utilizando o mercurial no endereço: rts Criar um usuário e o banco de dados no postgresql: Windows: createuser U postgres mandril createdb O mandril U postgres E UTF 8 mandril Linux: sudo su postgres createuser mandril createdb O mandril E UTF 8 mandril Configurar o aquivo mandril.properties: 8

9 Indicar o caminho do diretorio de armazenamento de arquivos (mandril.data.dir). Configurar outras properties quando for necessário. Muriqui Conferência Baixar o fonte utilizando o mercurial no endereço: code repository Criar um usuário e o banco de dados no postgresql: Windows: createuser U postgres conference createdb O conference U postgres E UTF 8 conference Linux: sudo su postgres createuser conference createdb O conference E UTF 8 conference Configurar o aquivo conference.properties: Indicar o caminho do diretorio de armazenamento de arquivos (data.dir). Configurar outras properties quando for necessário. Considerações Importantes Todos os banco de dados são gerenciados utilizando a ferramenta de controle de versões de banco de dados Liquibase. Para envio de é utilizado o serviço disponível pelo Application Server JBoss. O primata tem uma tarefa automatizada(ant) para configurar o arquivo de configuração do serviço de do JBoss baseado nas propriedades de configuração colocadas pelo usuário no primata. Em todo o projeto é utilizado o encoding UTF 8: na criação do banco de dados, nos testes, geração do , inicialização do servidor entre outros. O ambiente de testes precisa do banco de dados sempre com os dados de teste iniciais idênticos a cada teste unitário ou aceitação que acesse o banco. Como estamos utilizando uma ferramenta de versionamento de banco de dados(liquibase) e precisamos testar a migração de dados com dados de teste reais, não foi possível a utilização de um framework que auxilie neste processo. A técnica utilizada pode ser melhor visualizada olhando as tarefas automatizadas 9

10 'backup db' e 'restore db' do ant. Basicamente utilizamos a tarefa 'backup db' uma vez e a cada teste rodamos a tarefa 'restore db'. A tarefa 'backup db' deverá ser gerada uma vez antes dos testes e apagará as tabelas existentes, gerará as tabelas limpas, fará a inserção dos dados com o liquibase e gerará o dump de inserção de dados. A tarefa 'restore db' apaga o conteúdo do banco, desabilita as chaves estrangeiras, roda o dump de inserção e habilita as chaves estrangeiras. O que o desenvolvedor deve ficar atento é que ao inserir ou remover uma tabela do banco, todos os arquivos relacionados ao banco de dados que tratam dessa tabela devem ser alterados. Esses arquivos(delete_tables, drop_tables etc.) podem ser encontrados na pasta 'conf/database' dos projetos. Com exceção do guigoh você poderá rodar a tarefa automatizada 'all'* do Ant que rodará todos os testes, no caso do guigoh, pela complexidade e quantidade de testes o Selenium* pode ter alguns comportamentos imprevisíveis. O ideal para o Guigoh é que os testes de aceitação com o Selenium sejam executados por grupos de 5 por exemplo. *all: leia mais sobre tarefas automatizadas na pergunta 3 da lista de perguntas frequentes; *Selenium: ferramenta para testes de aceitação. Conhecidos também como testes de usuário, onde serão abertas janelas do navegador configurado, simulando a interação do usuário com o sistema. Perguntas frequentes 1 Em que servidores preciso me cadastrar para baixar os projetos? Para os projetos registrados no cvs, deverá ser feito um cadastro no servidor cvs do ipti.org.br; Para projetos com Mercurial será necessário o registro no 2 Segui os passos de inicialização, dei deploy na aplicação mas ela não funciona. 1.: Pode ser que as tabelas não tenham sido geradas, cada projeto possui uma tarefa automatizada chamada backup db para testes que fará esta inicialização. Para saber mais sobre as tarefas automatizadas olhe a pergunta sobre tarefas automatizadas logo abaixo; 2.: Tenha certeza de que todos os caminhos e configurações feitas nos arquivos de propriedades de cada projeto estejam corretas. 3.: Tenha certeza de que os passos de inicialização foram realizados 3 Quais tarefas automatizadas tem nos projetos? 10

11 O diretório raiz de cada projeto contém o arquivo build.xml que executa as tarefas automatizadas. Estas tarefas visam facilitar o desenvolvimento e algumas ações como, por exemplo, rodar o script de versionamento de banco de dados, gerar javadoc, rodar testes entre outros. Aqui está uma lista das principais tarefas automatizadas utilizadas pelos projetos. Geral: clean: limpa as classes compiladas; jar: gera o jar do projeto que for uma biblioteca; dist: gera o arquivo.war do projeto web; migrate db: roda o script de migração do banco de dados utilizando o liquibase. Sempre que houver modificação no banco de dados será necessário rodar está tarefa. Para ambiente de testes utilize a tarefa 'backup db'; minify css: compacta todos os arquivos css da aplicação para arquivos com uma só linha; minify js: compacta todos os arquivos javascript da aplicação para arquivos com uma só linha; javadoc: gera o javadoc do projeto; Específicos para teste: drop tables: apaga as tabelas do banco de dados; backup db: apaga as tabelas do BD, cria as tabelas, insere dados de teste, e gera dump do banco de dados(este dump é gerado para os testes popularem a base de dados com dados novos a cada teste). restore db: recupera os dados de teste apartir do dump realizado na target backup db; check code: faz verificação de código com PMD e FindBugs, os relatórios são gerados no diretório 'build' do projeto; all: compila, gera banco de dados, realiza o deploy, checa o código por erros e roda os testes. 4 Posso utilizar os projetos no Eclipse IDE? Teoricamente sim, mas não foi testado. Os projetos trabalham com o build Ant que o NetBeans gera e podem ter detalhes que amarram um pouco. Configurando Projeto para autenticação com o AccountService Criar o arquivo unprotectedresources.txt na pasta 'WEB INF' do seu projeto. Neste arquivo você colocará os arquivos desprotegidos da aplicação, ao invés de faze lo no web.xml. 11

12 Configurar o authhelper no web.xml do projeto(na parte em vermelho você pode configurar sua própria página de login ou utilizar a padrão como no exemplo): <filter> <filter name>authfilter</filter name> <filter class>br.org.ipti.authhelper.authverifierfilter</filter class> <init param> <param name>accountserviceurl</param name> <param value> value> </init param> <init param> <param name>loginpageurl</param name> <param value> </init param> <init param> <param name>unprotectedresourceslist</param name> <param value>web INF/unprotectedResources.txt</param value> </init param> </filter> <filter mapping> <filter name>authfilter</filter name> <url pattern>/*</url pattern> </filter mapping> 5 Deslogar automaticamente de vários projetos abertos no browser Por exemplo: Você está com o Guigoh, o Mandril e o Muriqui abertos em abas distintas no browser, ao deslogar do Guigoh, o Mandril e o Muriqui também serão deslogados e voltarão para as respectivas páginas de login. Como utilizar esta técnica em um projeto novo: 1.: Faça uma página ou utilize uma já existente que todas as páginas do seu projeto web utilizem; 2.: Nesta página coloque o seguinte bloco de código javascript: <script type="text/javascript"> $(document).ready( function() { var div = document.createelement( "div" ); $(div).css( "display", "none" ); $(div).load("/primata/close session verification.jsp"); } ); </script> 6 Tem outros projetos relacionados que fazem ou faziam parte desta plataforma? Sim. E todos os códigos estão em repositórios de controle de versão. O Saui: módulo para gerenciamento de compromissos e contatos. 12

13 Está disponível no endereço JSCO: implementação da especificação SCORM para ferramenta de ensino a distância. Está disponível no endereço cvs -d :pserver:username@cvs.dev.java.net:/cvs checkout jsco O Ipti-utils: Contém alguns utilitários. Está disponível no endereço: :ext:username@ipti.org.br:/cvsroot/ipti utils Implementação web do Mandril para o Opaals: opaals 13