Merge pull request #39 from computationalmodelling/FEAT-036

FEAT-036: Link virtual machines to environments

Author: mvousden

guest_resources/welcome/welcome_virtualmicromagnetics-fidimag.rst

@@ -9,6 +9,13 @@ software for simulation use, specifically:
 
 Documented examples are also available on the desktop.
 
+For more information on Virtual Micromagnetics, visit
+http://virtualmicromagnetics.org. Information about the environment that
+created the base box that this machine is built with, such as the version
+number, can be found in this `file
+</virtualmicromagnetics_machine_characteristics.txt>`_. Please include this
+information when reporting a suspected bug.
+
 This tool is provided by the University of Southampton (Mark Vousden, Max
 Albert, Hans Fangohr and others). Neither the University of Southampton nor the
 authors assume any responsibility whatsoever for its use by other parties, and

guest_resources/welcome/welcome_virtualmicromagnetics-full.rst

@@ -36,6 +36,13 @@ Other lower-level tools are installed for convenience, such as paraview, grace,
 gnuplot, the IPython (Jupyter) Notebook and more. This machine runs on 64-bit
 Ubuntu with Xfce as a desktop environment.
 
+For more information on Virtual Micromagnetics, visit
+http://virtualmicromagnetics.org. Information about the environment that
+created the base box that this machine is built with, such as the version
+number, can be found in this `file
+</virtualmicromagnetics_machine_characteristics.txt>`_. Please include this
+information when reporting a suspected bug.
+
 These tools are provided by the University of Southampton (Mark Vousden, Max
 Albert, Hans Fangohr and others). Neither the University of Southampton nor the
 authors assume any responsibility whatsoever for its use by other parties, and

guest_resources/welcome/welcome_virtualmicromagnetics-lite.rst

@@ -23,6 +23,13 @@ For more information about these packages, see their respective websites and
 examples available on the desktop, which walk the user through some examples
 and tests where applicable.
 
+For more information on Virtual Micromagnetics, visit
+http://virtualmicromagnetics.org. Information about the environment that
+created the base box that this machine is built with, such as the version
+number, can be found in this `file
+</virtualmicromagnetics_machine_characteristics.txt>`_. Please include this
+information when reporting a suspected bug.
+
 These tools are provided by the University of Southampton (Mark Vousden, Max
 Albert, Hans Fangohr and others). Neither the University of Southampton nor the
 authors assume any responsibility whatsoever for its use by other parties, and

guest_resources/welcome/welcome_virtualmicromagnetics-magpar.rst

@@ -9,6 +9,13 @@ software for simulation use, specifically:
 
 Documented examples are also available on the desktop.
 
+For more information on Virtual Micromagnetics, visit
+http://virtualmicromagnetics.org. Information about the environment that
+created the base box that this machine is built with, such as the version
+number, can be found in this `file
+</virtualmicromagnetics_machine_characteristics.txt>`_. Please include this
+information when reporting a suspected bug.
+
 This tool is provided by the University of Southampton (Mark Vousden, Max
 Albert, Hans Fangohr and others). Neither the University of Southampton nor the
 authors assume any responsibility whatsoever for its use by other parties, and

guest_resources/welcome/welcome_virtualmicromagnetics-nmag.rst

@@ -9,6 +9,13 @@ for simulation use, specifically:
 
 Documented examples are also available on the desktop.
 
+For more information on Virtual Micromagnetics, visit
+http://virtualmicromagnetics.org. Information about the environment that
+created the base box that this machine is built with, such as the version
+number, can be found in this `file
+</virtualmicromagnetics_machine_characteristics.txt>`_. Please include this
+information when reporting a suspected bug.
+
 This tool is provided by the University of Southampton (Mark Vousden, Max
 Albert, Hans Fangohr and others). Neither the University of Southampton nor the
 authors assume any responsibility whatsoever for its use by other parties, and

guest_resources/welcome/welcome_virtualmicromagnetics-oommf.rst

@@ -9,6 +9,13 @@ software for simulation use, specifically:
 
 Documented examples are also available on the desktop.
 
+For more information on Virtual Micromagnetics, visit
+http://virtualmicromagnetics.org. Information about the environment that
+created the base box that this machine is built with, such as the version
+number, can be found in this `file
+</virtualmicromagnetics_machine_characteristics.txt>`_. Please include this
+information when reporting a suspected bug.
+
 This tool is provided by the University of Southampton (Mark Vousden, Max
 Albert, Hans Fangohr and others). Neither the University of Southampton nor the
 authors assume any responsibility whatsoever for its use by other parties, and

roles/create_VM/tasks/main.yml

@@ -47,7 +47,7 @@
 
 - name: Obtain the current tag, (or version if untagged) of this repository.
   shell: |
-    TAG=$(git name-rev --tags --name-only HEAD)
+    TAG=$(git name-rev --tags --name-only HEAD | cut -f1 -d^)
     if [ "$(echo $TAG | tr -d [:space:])" == "undefined" ]; then
         git rev-parse --short HEAD
     else
@@ -66,6 +66,17 @@
     regexp="^[0-9a-zA-Z]*"
     line={{ current_version.stdout }}
 
+- name: Obtain build machine information.
+  shell: |
+    echo "Build VirtualBox version: $(VBoxManage --version)" > {{ vm_dir }}/build_information
+    echo "Build Vagrant version: $(vagrant --version)" >> {{ vm_dir }}/build_information
+    echo "Build hostname: $HOSTNAME" >> {{ vm_dir }}/build_information
+    echo "Uname output: $(uname -a)" >> {{ vm_dir }}/build_information
+    echo "lsb_release output: $(lsb_release -a)" >> {{ vm_dir }}/build_information
+  args:
+    chdir: "{{ vm_dir }}"
+    executable: /bin/bash
+
 - name: Start the virtual machine. Vagrant may attempt to install VirtualBox Guest Additions here.
   shell: vagrant up --no-provision > {{ vm_name }}.log
     chdir={{ vm_dir }}

roles/write_characteristics_file/meta/main.yml

@@ -0,0 +1,3 @@
+---
+dependencies:
+  - yaegashi.blockinfile

roles/write_characteristics_file/tasks/main.yml

@@ -0,0 +1,23 @@
+---
+# This Ansible playbook creates a characteristics file to help with bug
+# reporting.
+
+- name: Obtain version information.
+  command: cat /vagrant/repository_version
+  register: text
+
+- name: Obtain date.
+  command: date
+  register: date
+
+- name: Obtain other information.
+  command: cat /vagrant/build_information
+  register: build_info
+
+- name: Write characteristics file.
+  blockinfile:
+    dest=/virtualmicromagnetics_machine_characteristics.txt
+    create=yes
+    marker="# --- {mark} ADDED BY ANSIBLE ---"
+    content="Build virtualmicromagnetics version{{':'}} {{ text.stdout }}\nBuild date{{':'}} {{ date.stdout }}\n{{ build_info.stdout }}"
+  sudo: yes