FusionForge

Difference between revisions of "Virtual machine development environment"

From FusionForge Wiki
Jump to: navigation, search
(Running the test suite: document use_ssl=no testsuite trick)
m
 
(78 intermediate revisions by 5 users not shown)
Line 1: Line 1:
We provide a development virtual machine (aka FusionForge Sandbox) with an already configured automated tests environment. FusionForge is not pre-installed, it is automatically built using included scripts.
 
  
== Install Vagrant and VirtualBox ==
+
If you are looking for the root password for the .ova file ,
 +
(the other is a .vagrant file, contrary to what the posting says) :
  
To use the VM, please [http://docs.vagrantup.com/v2/installation/ install Vagrant] (>= v1.1). By default Vagrant uses [https://www.virtualbox.org/wiki/Downloads VirtualBox] so install it too.  
+
http://lists.fusionforge.org/pipermail/fusionforge-general/2010-November/001245.html
  
If you're running Debian or Ubuntu, the easiest way is:
+
http://fusionforge.fusionforge.org/sandbox/
 +
 
 +
it is user: root
 +
 
 +
password: vagrant
 +
 
 +
the .ova gives you a root-only XFCE running FF locally with scripts under  /usr/src/fusion...  .
 +
 
 +
 
 +
 
 +
We provide a 64-bit development/test Virtual Machine (aka FusionForge Sandbox) with an already configured automated tests environment. FusionForge is not pre-installed, it is packaged and installed using included automated scripts.
 +
 
 +
== Dependencies : Vagrant and VirtualBox ==
 +
 
 +
To use the VM, please [http://docs.vagrantup.com/v2/installation/ install Vagrant] (>= v1.1).
 +
 
 +
By default Vagrant uses [https://www.virtualbox.org/wiki/Downloads VirtualBox] so install it too.
 +
 
 +
* If you're running a recent Debian or Ubuntu, the following should work:
 
  aptitude install vagrant virtualbox
 
  aptitude install vagrant virtualbox
VirtualBox recently moved to the "contrib" section, so you need to enable it in your /etc/apt/sources.list:
+
Note: VirtualBox recently moved to the <tt>contrib</tt> section, so you need to enable it in your <tt>/etc/apt/sources.list</tt>, for instance by adding something like :
 
  deb http://ftp.fr.debian.org/debian/ jessie main contrib
 
  deb http://ftp.fr.debian.org/debian/ jessie main contrib
  
 
Make sure that you enabled '''hardware virtualization''' in your computer's BIOS, otherwise VirtualBox may not be able to run the VM.
 
Make sure that you enabled '''hardware virtualization''' in your computer's BIOS, otherwise VirtualBox may not be able to run the VM.
  
(Note: if you wish, you can extract the disk image from the <tt>.box</tt> and use it with KVM, see below.)
+
See also [[#Using_QEMU.2FKVM_instead_of_VirtualBox|use it with KVM]] if you want to extract the disk image from the <tt>.box</tt>.
 +
 
 +
== Starting the VM with Vagrant ==
  
== Run the VM with Vagrant ==
+
Note: installing the VM requires some free space (~700MB in your <tt>~/.vagrant.d/</tt> and ~1.5GB in <tt>~/VirtualBox VMs</tt>).
  
vagrant init fusionforge-dev-debian http://fusionforge.fusionforge.org/sandbox/fusionforge-dev-debian.box
+
* Save this [https://scm.fusionforge.org/anonscm/gitweb/?p=fusionforge/fusionforge.git;a=blob_plain;f=vm/Vagrantfile-sample;hb=6.0 Vagrant configuration] in a directory of your choice and rename it as <tt>Vagrantfile</tt>.
# optionaly modify 'Vagrantfile', e.g. enable 'vb.gui' to open the graphics display.
+
* Edit the Vagrantfile if needed (e.g. if <tt>192.168.35.11</tt> is already taken on your network)
 +
* In your host's <tt>/etc/hosts</tt>, add:
 +
192.168.35.11 forge.internal lists.forge.internal scm.forge.internal users.forge.internal
 +
* Go in the directory where the Vagrantfile was saved
 +
cd {the directory you have chosen}
 +
* Download, create and start the VM with:
 
  vagrant up
 
  vagrant up
 +
* You now can login without a password:
 
  vagrant ssh -- -l root
 
  vagrant ssh -- -l root
 
You can get inspiration from [https://fusionforge.org/plugins/scmgit/cgi-bin/gitweb.cgi?p=fusionforge/fusionforge.git;a=blob;f=vm/Vagrantfile-sample;hb=HEAD vm/Vagrantfile-sample] for the configuration.
 
  
 
If the VM doesn't start, try to launch the VirtualBox manager and start the VM manually: you'll have a more detailed error message.
 
If the VM doesn't start, try to launch the VirtualBox manager and start the VM manually: you'll have a more detailed error message.
  
== Presentation ==
+
Note: for an alternative with a NAT, cf. the tip [[#Accessing_the_web_interface_from_host_-_alternative_with_port_redirection|alternative with port redirection]] below.
  
This VM/appliance is designed to help you get started on development. It's basically a clean Debian system, with a checkout of the FusionForge code and a few helper scripts. Those scripts are in the <tt>/usr/src/fusionforge/vm/scripts</tt> directory:
+
== Building and installing FusionForge ==
  
* <tt>update.sh</tt> will update the sources from Debian FusionForge's Git repository, and also the currently installed packages.
+
This VM/appliance is basically a clean Debian system (jessie/stable), with a git clone/checkout of the FusionForge [https://scm.fusionforge.org/anonscm/gitweb/?p=fusionforge/fusionforge.git;a=shortlog;h=6.0 debian/6.0] code in <tt>/usr/src/fusionforge/</tt>. Make sure to update with:
* <tt>build.sh</tt> builds FusionForge packages from the sources, and stores them in the package repository at <tt>/usr/src/debian-repository/</tt>.
+
cd /usr/src/fusionforge/
* <tt>install.sh</tt> installs those FusionForge packages. This should end up with an up-to-date FusionForge running on http://forge.internal/ , with the administrator's login being “admin” and its password being “myadmin”.
+
git pull
* <tt>install-gui.sh</tt> optionally sets up an X11 graphical environment.
+
apt-get update
* <tt>run-testsuite.sh</tt> installs Selenium and runs the testsuite
 
  
We recommend you run these scripts in order.
+
To build and install FusionForge, you just need to run helper scripts from the <tt>/usr/src/fusionforge/autoinstall/</tt> directory, namely:
There's an icon on the VM's Desktop to run <tt>build.sh+install.sh</tt>, and another one for <tt>run-testsuite.sh</tt>.
+
* '''<tt>build.sh</tt>''' automatically builds FusionForge Debian (or RPM) packages from source, and stores them in a local package repository in <tt>/usr/src/debian-repository/</tt>.
 +
* '''<tt>install.sh</tt>''' installs these FusionForge packages.
  
The actual source code is stored under <tt>/usr/src/fusionforge</tt>, so that's where you should do the changes you want to test.
+
You now have an up-to-date FusionForge running on http://forge.internal/  , but only inside of the VM. So you need to install the GUI using the script install-GUI.sh
 +
The fusionforge administrator's web login is <tt>admin</tt>, set the admin password with:
 +
forge_set_password admin 'my%admin'
  
== Accessing the web interface from host - using an internal IP ==
+
== Running the test suite ==
  
In the <tt>Vagrantfile</tt>, add:
+
The VM is ready to run the ''functionnal'' [[Test_Suite|test suite]], which uses PHPUnit and Selenium to drive a controlled Web browser through various tests of the different features of the forge (hence ''functionnal'' tests), using its highest-level interface: its Web interface.
config.vm.network :private_network, ip: "192.168.35.11"
 
(replace 192.168.35.11 with any IP that does *not* exist)
 
  
And in your host's <tt>/etc/hosts</tt>, add:
+
''Note: you don't need to do this if you just want to test FusionForge. This is for running the test suite to ensure you didn't break anything when developping.''
192.168.35.11 forge.internal
 
  
Then hit http://forge.internal/ !
+
A couple other scripts run the test suite:
 +
* '''<tt>tests/func_tests.sh</tt>''' installs Selenium and runs the testsuite; use TESTGLOB='func/sometest/*' to limit the tests
 +
* '''<tt>autoinstall/install-gui.sh</tt>''' optionally sets up an X11 graphical environment.
  
== Stalled SSH access ==
+
There's also an icon on the VM's Desktop to run <tt>build.sh+install.sh</tt>, and another one for <tt>func_tests.sh</tt>.
  
If user SSH access to the VM is stalling, check that nscd is installed:
+
Tests need around 25mn to complete, depending on the computing power of your machine.
aptitude install unscd
+
Failure screenshots are stored in <tt>/var/log/</tt>.
See the thread ([http://lists.fusionforge.org/pipermail/fusionforge-general/2014-February/002548.html 1], [http://lists.fusionforge.org/pipermail/fusionforge-general/2014-March/002631.html 2]) about this issue.
 
  
== Running the test suite ==
+
=== Running graphical programs remotely ===
  
(Note: you don't need to do this if you just want to test FusionForge. This is for running the test suite to ensure you didn't break anything when developping.)
+
If you don't want to install a full GUI on the VM (i.e. not using <tt>install-gui.sh</tt>), you can also run the interesting things remotely through SSH using
 +
vagrant ssh -- -l root -X
  
First, we need a few manual steps to avoid Firefox self-signed certificate error dialogs when running selenium tests.
+
Note that since Selenium needs an X11 display (as it drives a graphical web browser), you may then see the full graphical run of the test suite on your local X display in a new Firefox window.
  
Method 1 (used *ahem* in the buildbot): add this to <tt>/etc/fusionforge/config.ini.d/zzzz-local.ini</tt>:
+
You may prefer running the X display inside the VM to start the selenium server, so that windows opened by the tests don't bother you.
[core]
 
use_ssl = no
 
  
Method 2:
+
=== Headless run ===
* Connect to the VM with the graphic window enabled (cf. vb.gui above).
 
* Close your existing Firefox windows (if any) and run:
 
firefox -ProfileManager
 
* Configure a new Firefox profile in a directory of your choice, e.g. <tt>/usr/src/fusionforge/tests/ff-profile-selenium/</tt>
 
* Still in Firefox, visit https://forge.internal/ and add an exception for the self-signed certificate
 
* Close Firefox
 
* To run the tests with the corresponding Firefox profile, pass a <tt>-firefoxProfileTemplate</tt> option to selenium in <tt>/usr/src/fusionforge/tests/scripts/phpunit.sh</tt>:
 
PATH=/usr/lib/iceweasel:$PATH LANG=C java -jar /usr/share/selenium/selenium-server.jar -firefoxProfileTemplate /usr/src/fusionforge/tests/ff-profile-selenium/ -singleWindow >/dev/null &
 
  
Now you can run the testsuite script in a terminal, or click on the Desktop "run testsuite" shortcut (may take a few minutes to start):
+
'''<tt>func_tests-xvnc.sh</tt>''' runs the testsuite after setting up a fake VNC/X11 environment:
  /usr/src/fusionforge/vm/scripts/run-testsuite.sh
+
  tests/func_tests-xvnc.sh deb/debian
  
=== Running remotely ===
+
=== Run only some tests ===
  
If you don't want to install a full GUI on the VM, you can also run the interesting things remotely through SSH using
+
Use the TESTGLOB environment variable, e.g.:
  vagrant ssh -- -l root -X
+
  TESTGLOB='func/50_PluginsScmGit/*' ./func_tests.sh deb/debian
Note that Selenium needs an X11 display (since it drives a graphical web browser).
 
  
You may prefer running the X display inside the VM to start the selenium server, so that windows opened by the tests don't bother you.
+
Another example in headless mode:
 +
TESTGLOB='func/30_RBAC/*' ./func_tests-xvnc.sh src/debian
  
== Tips ==
+
== Tips, Issues and FAQs ==
  
 
=== To reset the FusionForge admin password ===
 
=== To reset the FusionForge admin password ===
  
Use: <tt>/usr/share/gforge/bin/forge_set_password admin</tt>
+
forge_set_password admin yournewpassword
 +
 
 +
FF deliberately is so terse. So you don't know whether its a web passwd or a bash login passwd. very amateurish.
  
 
=== Accessing the web interface from host - alternative with port redirection ===
 
=== Accessing the web interface from host - alternative with port redirection ===
Line 108: Line 125:
  
 
And in your host's <tt>/etc/hosts</tt>, add:
 
And in your host's <tt>/etc/hosts</tt>, add:
  127.0.0.1 forge.internal
+
  127.0.0.1 forge.internal lists.forge.internal scm.forge.internal users.forge.internal
  
 
Then hit http://forge.internal:8080/ !
 
Then hit http://forge.internal:8080/ !
 +
 +
Attention : the test suite might not work well in such a configuration
  
 
=== Using psql as root ===
 
=== Using psql as root ===
Line 116: Line 135:
 
  su - postgres -c "psql -c 'CREATE ROLE root WITH LOGIN SUPERUSER'"
 
  su - postgres -c "psql -c 'CREATE ROLE root WITH LOGIN SUPERUSER'"
  
=== Use a stable Git branch ===
+
=== Use the development Git branch ===
  
If you want to use the 5.3 stable branch (instead of the development branch), you can:
+
If you want to use the latest development branch (to contribute to FusionForge or test the unreleased features), you can:
 
  cd /usr/src/fusionforge/
 
  cd /usr/src/fusionforge/
  git checkout debian/5.3
+
  git checkout debian/master
  
Note: if you already installed the development version, make sure you uninstall your FusionForge first because the packages won't be downgraded automatically to stable:
+
Note: if you switch back to an earlier version (e.g. from development back to stable), make sure you uninstall your FusionForge first because the packages won't be downgraded automatically:
  vm/scripts/uninstall.sh
+
  autoinstall/uninstall.sh
 
  rm -rf /usr/src/debian-repository/
 
  rm -rf /usr/src/debian-repository/
 +
 +
=== Block outgoing e-mails ===
 +
 +
Useful if you're working on a database import with real user e-mails...
 +
iptables -A OUTPUT -p tcp --dport 25 -j REJECT --reject-with tcp-reset
  
 
== Using QEMU/KVM instead of VirtualBox ==
 
== Using QEMU/KVM instead of VirtualBox ==
Line 146: Line 170:
 
== CentOS variant ==
 
== CentOS variant ==
  
A version of the VM for CentOS 6 is available:
+
A version of the VM for CentOS 7 is available:
http://fusionforge.fusionforge.org/sandbox/fusionforge-dev-centos.box
+
http://fusionforge.fusionforge.org/sandbox/fusionforge-dev-centos7.box
 +
 
 +
The above scripts also work for this VM.
  
However there are not scripts for this version. You need to build and install FusionForge manually.
+
Properly set your hostname though:
 +
echo '192.168.35.11 forge.internal lists.forge.internal scm.forge.internal users.forge.internal' >> /etc/hosts
 +
service nscd restart
  
 
== Modify the VM ==
 
== Modify the VM ==
  
 
The VM is automatically generated from scratch using the [http://www.packer.io/ Packer] tool.
 
The VM is automatically generated from scratch using the [http://www.packer.io/ Packer] tool.
See the Packer configuration in <tt>vm/packer/</tt>.
+
See the Packer configuration in <tt>vm/packer/</tt>. One advantage of packer is its ability to create a VM with a disk of arbitrary size.
 +
 
 +
== LXC / buildbot development environment ==
 +
 
 +
If you plan to test FusionForge under multiple distros and versions, you can reproduce the LXC setup used by our build bot on your computer.
 +
 
 +
It supports Debian 7 & 8 and CentOS 5, 6 & 7.
 +
 
 +
See [[Tools/BuildBot]].
  
 
== Links ==
 
== Links ==
Line 160: Line 196:
 
* [http://lists.fusionforge.org/pipermail/fusionforge-general/2010-November/001245.html Original announcement]
 
* [http://lists.fusionforge.org/pipermail/fusionforge-general/2010-November/001245.html Original announcement]
 
* [http://lists.fusionforge.org/pipermail/fusionforge-general/2014-January/002539.html Vagrant/Packer announcement]
 
* [http://lists.fusionforge.org/pipermail/fusionforge-general/2014-January/002539.html Vagrant/Packer announcement]
 +
 +
[[Category:Development]]

Latest revision as of 04:44, 23 February 2018

If you are looking for the root password for the .ova file , (the other is a .vagrant file, contrary to what the posting says) :

http://lists.fusionforge.org/pipermail/fusionforge-general/2010-November/001245.html

http://fusionforge.fusionforge.org/sandbox/

it is user: root

password: vagrant

the .ova gives you a root-only XFCE running FF locally with scripts under /usr/src/fusion... .


We provide a 64-bit development/test Virtual Machine (aka FusionForge Sandbox) with an already configured automated tests environment. FusionForge is not pre-installed, it is packaged and installed using included automated scripts.

Dependencies : Vagrant and VirtualBox

To use the VM, please install Vagrant (>= v1.1).

By default Vagrant uses VirtualBox so install it too.

  • If you're running a recent Debian or Ubuntu, the following should work:
aptitude install vagrant virtualbox

Note: VirtualBox recently moved to the contrib section, so you need to enable it in your /etc/apt/sources.list, for instance by adding something like :

deb http://ftp.fr.debian.org/debian/ jessie main contrib

Make sure that you enabled hardware virtualization in your computer's BIOS, otherwise VirtualBox may not be able to run the VM.

See also use it with KVM if you want to extract the disk image from the .box.

Starting the VM with Vagrant

Note: installing the VM requires some free space (~700MB in your ~/.vagrant.d/ and ~1.5GB in ~/VirtualBox VMs).

  • Save this Vagrant configuration in a directory of your choice and rename it as Vagrantfile.
  • Edit the Vagrantfile if needed (e.g. if 192.168.35.11 is already taken on your network)
  • In your host's /etc/hosts, add:
192.168.35.11 forge.internal lists.forge.internal scm.forge.internal users.forge.internal
  • Go in the directory where the Vagrantfile was saved
cd {the directory you have chosen} 
  • Download, create and start the VM with:
vagrant up
  • You now can login without a password:
vagrant ssh -- -l root

If the VM doesn't start, try to launch the VirtualBox manager and start the VM manually: you'll have a more detailed error message.

Note: for an alternative with a NAT, cf. the tip alternative with port redirection below.

Building and installing FusionForge

This VM/appliance is basically a clean Debian system (jessie/stable), with a git clone/checkout of the FusionForge debian/6.0 code in /usr/src/fusionforge/. Make sure to update with:

cd /usr/src/fusionforge/
git pull
apt-get update

To build and install FusionForge, you just need to run helper scripts from the /usr/src/fusionforge/autoinstall/ directory, namely:

  • build.sh automatically builds FusionForge Debian (or RPM) packages from source, and stores them in a local package repository in /usr/src/debian-repository/.
  • install.sh installs these FusionForge packages.

You now have an up-to-date FusionForge running on http://forge.internal/ , but only inside of the VM. So you need to install the GUI using the script install-GUI.sh The fusionforge administrator's web login is admin, set the admin password with:

forge_set_password admin 'my%admin'

Running the test suite

The VM is ready to run the functionnal test suite, which uses PHPUnit and Selenium to drive a controlled Web browser through various tests of the different features of the forge (hence functionnal tests), using its highest-level interface: its Web interface.

Note: you don't need to do this if you just want to test FusionForge. This is for running the test suite to ensure you didn't break anything when developping.

A couple other scripts run the test suite:

  • tests/func_tests.sh installs Selenium and runs the testsuite; use TESTGLOB='func/sometest/*' to limit the tests
  • autoinstall/install-gui.sh optionally sets up an X11 graphical environment.

There's also an icon on the VM's Desktop to run build.sh+install.sh, and another one for func_tests.sh.

Tests need around 25mn to complete, depending on the computing power of your machine. Failure screenshots are stored in /var/log/.

Running graphical programs remotely

If you don't want to install a full GUI on the VM (i.e. not using install-gui.sh), you can also run the interesting things remotely through SSH using

vagrant ssh -- -l root -X

Note that since Selenium needs an X11 display (as it drives a graphical web browser), you may then see the full graphical run of the test suite on your local X display in a new Firefox window.

You may prefer running the X display inside the VM to start the selenium server, so that windows opened by the tests don't bother you.

Headless run

func_tests-xvnc.sh runs the testsuite after setting up a fake VNC/X11 environment:

tests/func_tests-xvnc.sh deb/debian

Run only some tests

Use the TESTGLOB environment variable, e.g.:

TESTGLOB='func/50_PluginsScmGit/*' ./func_tests.sh deb/debian

Another example in headless mode:

TESTGLOB='func/30_RBAC/*' ./func_tests-xvnc.sh src/debian

Tips, Issues and FAQs

To reset the FusionForge admin password

forge_set_password admin yournewpassword

FF deliberately is so terse. So you don't know whether its a web passwd or a bash login passwd. very amateurish.

Accessing the web interface from host - alternative with port redirection

A bit more complicated than using an internal IP, but doesn't need a separate IP.

In the Vagrantfile, add:

config.vm.network :forwarded_port, guest: 80,  host: 8080
config.vm.network :forwarded_port, guest: 443, host: 8443

In /etc/fusionforge/config.ini.d/zzzz-local.ini, add:

[core]
http_port=8080
https_port=8443

And in your host's /etc/hosts, add:

127.0.0.1 forge.internal lists.forge.internal scm.forge.internal users.forge.internal

Then hit http://forge.internal:8080/ !

Attention : the test suite might not work well in such a configuration

Using psql as root

su - postgres -c "psql -c 'CREATE ROLE root WITH LOGIN SUPERUSER'"

Use the development Git branch

If you want to use the latest development branch (to contribute to FusionForge or test the unreleased features), you can:

cd /usr/src/fusionforge/
git checkout debian/master

Note: if you switch back to an earlier version (e.g. from development back to stable), make sure you uninstall your FusionForge first because the packages won't be downgraded automatically:

autoinstall/uninstall.sh
rm -rf /usr/src/debian-repository/

Block outgoing e-mails

Useful if you're working on a database import with real user e-mails...

iptables -A OUTPUT -p tcp --dport 25 -j REJECT --reject-with tcp-reset

Using QEMU/KVM instead of VirtualBox

Converting from Virtualbox image format to QEMU qcow2

Converting from Virtualbox image format to QEMU qcow2: convert to raw format first

tar xf fusionforge-dev.box fusionforge-dev-disk1.vmdk
VBoxManage clonehd -format RAW fusionforge-dev-disk1.vmdk ffsandbox.raw  # ~10GB

Then optionaly convert to QCOW2 format:

qemu-img convert -f raw -O qcow2 ffsandbox.raw ffsandbox.qcow2

Running inside libvirt

  • Create a VM by importing the created qcow2 disk image, with virt-manager.
  • You may need to set manually the driver type to 'qcow2' in "disk" device section in the VM xml file (in /etc/libvirt/qemu/). In this case you need to redefine the VM xml file by: `sudo virsh -c qemu:///system define /etc/libvirt/qemu/ffsandbox.xml` then start the VM.
  • You need to reconfigure network interfaces in /etc/network/interfaces afterwards for replicating eth0 config stanza for eth1 for instance. You can find which device to enable by running ifconfig -a.
  • You may need to check the web_host setting in /etc/fusionforge/config.ini.d/debian-install.ini to adjust the forge's URLs for redirections.

CentOS variant

A version of the VM for CentOS 7 is available: http://fusionforge.fusionforge.org/sandbox/fusionforge-dev-centos7.box

The above scripts also work for this VM.

Properly set your hostname though:

echo '192.168.35.11 forge.internal lists.forge.internal scm.forge.internal users.forge.internal' >> /etc/hosts
service nscd restart

Modify the VM

The VM is automatically generated from scratch using the Packer tool. See the Packer configuration in vm/packer/. One advantage of packer is its ability to create a VM with a disk of arbitrary size.

LXC / buildbot development environment

If you plan to test FusionForge under multiple distros and versions, you can reproduce the LXC setup used by our build bot on your computer.

It supports Debian 7 & 8 and CentOS 5, 6 & 7.

See Tools/BuildBot.

Links