Instalación de OpenGrok en Linux Ubuntu y Windows

En esta sección veremos con instalar el buscador de código fuente OpenGrok en Linux Ubuntu (aunque puede aplicar para otras distribuciones) y la aplicación requerida Exuberant Ctags.

Antes de comenzar debe tener instalados Java y un servidor de aplicaciones o un contenedor de servlets, en nuestro caso utilizaremos Apache Tomcat. Si no los tiene instalados puede seguir las guías de instalación para Ubuntu:

Para Windows:

Nos referiremos a las carpetas de instalación como $<aplicación>_HOME, por ejemplo $OPENGROK_HOME, $TOMCAT_HOME, $JAVA_HOME para evitar rutas absolutas en la guía.

1. Instalación de Exuberant Ctags
1.1. Realice la instalación de acuerdo al sistema operativo.

Para Linux, en una consola de comandos ejecute (o use el comando adecuado de acuerdo a la distribución):
sudo apt-get install exuberant-ctags

Para Windows, siga la guía de instalación:

1.2. Ejecute el comando ctags para verificar que la instalación fue correcta. Si tiene la librería instalada deberá obtener un mensaje como el siguiente:

ctags: No files specified. Try "ctags —help".

2. Instalación de OpenGrok
2.1. Vaya a la web de descarga de OpenGrok en http://hub.opensolaris.org/bin/view/Project+opengrok/WebHome y descargue el instalador.

InstalacionUbuntu03.png

2.2. Descomprímalo en una carpeta con los permisos adecuados.
Por ejemplo en Linux:

tar -xvf opengrok-0.9.tar.gz

En Windows puede usar un descompresor como 7zip o usar el que viene integrado con el sistema operativo.

2.3. La siguiente tarea es configurar la aplicación Web de OpenGrok para que busque en un archivo indexado ubicado en el sistema de archivos local. Para este ejemplo escogeremos una carpeta dentro del directorio de instalación de OpenGrok, algo poco recomendable a largo plazo en caso de actualizar versiones, pero que nos sirve en este caso.
Edite el archivo web.xml que se encuentra en el archivo source.war carpeta WEB-INF de la carpeta lib y busque la sección context-param.
Modifique el valor del parámetro CONFIGURATION para que apunte a un archivo dentro del directorio de instalación (el archivo más adelante en el proceso de indexación), en este caso:

$OPENGROK_HOME/data/configuration.xml
InstalacionUbuntu06.png

2.4. Cree la carpeta data dentro del directorio de instalación OpenGrok.

cd $OPENGROK_HOME
mkdir data

2.5. Copie el archivo source.war que está en la carpeta lib en la carpeta de aplicaciones web de Tomcat:

Linux:

cp $OPENGROK_HOME/lib/source.war $TOMCAT_HOME/webapps/

Windows:

copy $OPENGROK_HOME\lib\source.war $TOMCAT_HOME\webapps

2.6. Inicie Tomcat o reinícielo si ya está arriba y visite la URL http://<servidor>:8080/source. Verá la página de búsqueda de OpenGrok, similar a la siguiente imagen:

InstalacionUbuntu05.png

3. Indexar una carpeta de ejemplo
En este paso vamos a descargar un proyecto de ejemplo, indexarlo y buscar a través de la interfaz web.

3.1. Si no cuenta con un cliente de Subversion instale uno.

En Linux:

sudo apt-get install subversion

Para Windows puede usar el cliente gratuito que oferece CollabNet en la URL http://www.collab.net/downloads/subversion/.

3.2. Ejecute el comando svn para verificar que la instalación fue exitosa. Obtendrá un mensaje similar al siguiente (en mi caso tengo una instalación en español):

Tipee «svn help» para ver el modo de uso

3.3. En los siguientes pasos vamos a descargar como ejemplo el código fuente del plugin de Sonar para Hudson (aunque sirve cualquier otro proyecto).

3.4. Cree una carpeta llamada source dentro del directorio de instalación de OpenGrok y ubíquese en ella para descargar el código fuente.

mkdir $OPENGROK_HOME/source
cd $OPENGROK_HOME/source/

3.5. Descargue el código fuente del plugin dentro de la carpeta creada:

svn checkout https://svn.java.net/svn/hudson~svn/trunk/hudson/plugins/sonar/ sonarplugin

Si se lo solicita, acepte el certificado digital del sitio web. En la carpeta sonarplugin está ahora la estructura descargada.

InstalacionUbuntu07.png

3.6. Ubíquese en la carpeta lib del directorio de instalación ($OPENGROK_HOME) de OpenGrok y ejecute el siguiente comando para indexar el código descargado:

java -jar opengrok.jar -W ../data/configuration.xml -P -S -v -s ../source/ -d ../data/
InstalacionUbuntu08.png

3.7. Inicie/reinicie Apache Tomcat (aunque no estoy seguro si es necesario reiniciar) y vaya al sitio principal de OpenGrok en http://<servidor>:8080/source. Ahora verá una pantalla similar a la mostrada en la imagen donde el proyecto sonarplugin aparece como una de las carpetas de búsqueda.

InstalacionUbuntu09.png

3.8. Seleccione el proyecto sonarplugin, introduzca alguna palabra clave (por ejemplo hudson, sonar, abstract) y presione buscar para comprobar que el proyecto fue indexado y se puede navegar sin problemas.

InstalacionUbuntu10.png

Si llegó hasta este punto la instalación de OpenGrok fue exitosa. Siga probando e intente las distintas opciones de búsqueda para que se familiarice con la herramienta.

Si no se indica lo contrario, el contenido de esta página se ofrece bajo Creative Commons Attribution-ShareAlike 3.0 License