pi-bake 0.1.0

data/Gemfile

@@ -0,0 +1,39 @@
+###
+### Sources
+###
+
+# Main Ruby Gems site
+source "http://rubygems.org"
+
+###
+### Core Gems. These are required in _all_ environments (additional environments
+###            follow).
+###
+
+# Core Application Frameworks
+gem "facets", "~> 2.9.3"
+gem "thor", "~> 0.15.0"
+gem "open4", "~> 1.3.0"
+
+# Core parsing libraries
+gem "psych", "~> 1.3.2"
+gem "nokogiri"
+
+# Core archive library
+gem "rubyzip", "~> 0.9.8"
+
+###
+### Development Gems. All _additional_ gems required by development (as opposed to
+###                   production environments). If it is required at run-time, it
+###                   belongs above.
+group :development do
+    
+  # Gem management tools
+  gem "bundler", "~> 1.1.0"
+  gem "gemcutter"
+  gem "gem-this"
+  
+  # Documentation Tools
+  gem "vclog"
+    
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.4.3)
+    facets (2.9.3)
+    gem-this (0.3.7)
+    gemcutter (0.7.1)
+    json (1.7.3)
+    nokogiri (1.5.5)
+    open4 (1.3.0)
+    psych (1.3.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rubyzip (0.9.9)
+    thor (0.15.4)
+    vclog (1.9.2)
+      ansi (>= 1.2)
+      facets (>= 2.4)
+      rdoc
+      xml-simple
+    xml-simple (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  facets (~> 2.9.3)
+  gem-this
+  gemcutter
+  nokogiri
+  open4 (~> 1.3.0)
+  psych (~> 1.3.2)
+  rubyzip (~> 0.9.8)
+  thor (~> 0.15.0)
+  vclog

data/README.markdown

@@ -0,0 +1,26 @@
+# FreeBSD Raspbery Pi Image Builder #
+
+This builder creates pre-prepared SD cards for the Raspbery PI, based on the official Debian build provided by the Raspbery PI foundation. However it also includes several customisations, aimed at supporting the use of the Raspbery PI within the Networking Labs, at the Department of Computing at Sheffield Hallam University.
+
+**Note:** This means this build is *not* suitable as a general-use/media machine. We don't have any graphical interfaces or other applications you will find in other builds. If you are not interested in something that might fall under the title "embedded router", please try [something else][http://www.raspberrypi.org/downloads].
+
+# Contributing to pi-bake #
+ 
+* Check out the latest master to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't
+  requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you
+  want to have your own version, or is otherwise necessary, that is
+fine, but please isolate to its own commit so I can cherry-pick around
+it.
+
+# Copyright #
+
+Copyright (c) 2012 David Love. See LICENSE.txt for
+further details.

data/bin/bake

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+### Copyright (c) 2012 David Love <david@homeunix.org.uk>
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+### @author David Love
+###
+### Bake Command. Creates disk images and provides the bootstrapping
+### environment needed for setting up a Raspberry Pi model B as an
+### embedded router.  
+###
+
+# Add lib to load path
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+
+# Make sure we can find the libraries installed by Ruby Gems
+require "rubygems"
+
+# Add core and standard library requires
+require 'digest'
+require 'find'
+require 'fileutils'
+require 'tempfile'
+
+# Add the command line parsing framework
+require "thor"
+
+# Add the YAML processing libraries
+#require 'psych'
+require 'yaml'
+
+# Add utilities from the Facets library
+#require 'facets'
+
+# Add the library needed to handle .zip files
+require 'zip/zip'
+
+##
+## Core Command Line Application
+##
+
+# Load in the enabled sub-commands
+require "actions/all"
+
+class Bake < Thor
+
+  include Thor::Actions
+
+end
+
+# Run the application
+Bake.start

data/lib/actions/all.rb

@@ -0,0 +1,31 @@
+### Copyright (c) 2012 David Love <david@homeunix.org.uk>
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+### @author David Love
+###
+### List of all defined command. Holding area for all commands that should be
+### included by the main `bake` binary. This also enables you to
+### temporarily enable/disable commands in the main application.
+###
+
+# List of Enabled Commands
+require "actions/attach"
+require "actions/detach"
+require "actions/image"
+require "actions/info"
+require "actions/mount"
+require "actions/unmount"
+require "actions/update"
+

data/lib/actions/attach.rb

@@ -0,0 +1,42 @@
+### Copyright (c) 2012 David Love <david@homeunix.org.uk>
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+### @author David Love
+###
+### Attach an image to the device tree. Creates a device node for an
+### existing image, allowing the image to be accessed using the standard
+### file and disk manipulation commands.
+###
+
+# File handling classes
+require "fs/geom"
+
+class Bake < Thor
+
+  desc "attach [IMAGE NAME]", "Create a device node to access the named image"
+
+  def attach(image_name = "pi.img")
+    say("Attaching image #{image_name}")
+    
+    device_name = Geom.attach_image(image_name)
+    
+    unless device_name.nil? then
+      say("...Image attached to #{device_name}")
+    else
+      say("ERROR: Could not attach #{image_name}")
+    end
+  end
+
+end

data/lib/actions/detach.rb

@@ -0,0 +1,36 @@
+### Copyright (c) 2012 David Love <david@homeunix.org.uk>
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+### @author David Love
+###
+### Attach an image to the device tree. Creates a device node for an
+### existing image, allowing the image to be accessed using the standard
+### file and disk manipulation commands.
+###
+
+# File handling classes
+require "fs/geom"
+
+class Bake < Thor
+
+  desc "detach [DEVICE]", "Detach the image linked to the named device"
+
+  def detach(device_name)
+    say("Detaching device #{device_name}")
+    
+    Geom.detach_image(device_name)
+  end
+
+end

data/lib/actions/image.rb

@@ -0,0 +1,87 @@
+### Copyright (c) 2012 David Love <david@homeunix.org.uk>
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+### @author David Love
+###
+### Image command. Creates the core disk image used as the master
+### for the SD Card, booted by the Pi board.
+###
+
+# File handling classes
+require "fs/geom"
+
+class Bake < Thor
+
+  desc "image [IMAGE NAME] [IMAGE SIZE]", "Prepare the SD Card image"
+
+  def image(image_name = "pi", image_size = 4)
+    # Create the full image name
+    full_image_name = image_name + ".img"
+    say("Creating the image file #{full_image_name}", :blue)
+
+    # Work out the image size in bytes
+    image_size_bytes = image_size * 1024 * 1024 * 1024
+
+    ## Check for the existence of the named image in the current
+    ## directory. If the image doesn't exist (or the user confirms
+    ## an overwrite of the existing image), the image file is created
+    
+    if File.exists?(full_image_name) then
+      if file_collision(full_image_name) then
+        Geom.make_image(full_image_name, image_size_bytes)
+      else
+        say("Cannot create the requested image", :red)
+        exit(1)
+      end
+    else
+      Geom.make_image(full_image_name, image_size_bytes)
+    end
+
+    ##
+    ## Now we need to partition the image, to create the basic disk
+    ## structures
+    ##
+    
+    say("Creating a device node for the image file...", :blue)
+    
+    # Attach the image to the kernel device tree
+    device_name = Geom.attach_image(full_image_name)
+    if device_name.nil?  then
+      say("Cannot create the device node needed to access the requested image", :red)
+      exit(1)
+    end
+    
+    say("... Image file attached to #{device_name}", :blue)
+
+    # Partition the disk image, creating the boot partition
+    # and two system partition and a data partition. The basic
+    # disk structures should like like the following
+    #
+    # partition 1: FAT32, 10% of the total disk  
+    # partition 2: EXT2,  25% of the total disk  
+    # partition 3: EXT2,  25% of the total disk  
+    # partition 4: EXT2,  40% of the total disk
+    #
+    say("Partitioning the image file", :blue)
+    
+    Geom.prepare_image(device_name, image_size_bytes)
+
+    # Finally detach the image
+    say("Detaching the image file attached to #{device_name}", :blue)
+
+    Geom.detach_image(device_name)
+  end
+
+end

data/lib/actions/info.rb

@@ -0,0 +1,61 @@
+### Copyright (c) 2012 David Love <david@homeunix.org.uk>
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+### @author David Love
+###
+### Display image command. Shows information about the image file, obtained
+### from the file system wherever possible. This command is principally
+### used to debug problems during development.
+###
+
+# File handling classes
+require "fs/geom"
+
+class Bake < Thor
+
+  desc "info [IMAGE NAME]", "Display information about the image file"
+
+  def info(image_name = "pi")
+    full_image_name = image_name + ".img"
+
+    # Attach the image to the device tree so that we can have a
+    # look at it
+
+    say("Creating a device node for the image file #{full_image_name}...", :blue)
+    
+    # Attach the image to the kernel device tree
+    device_name = Geom.attach_image(full_image_name)
+    if device_name.nil?  then
+      say("Cannot create the device node needed to access the requested image", :red)
+      exit(1)
+    end
+    
+    say("... Image file attached to #{device_name}", :blue)
+
+    # Display the structures reported by FDisk
+
+    puts
+    puts "  Summary of the image partition layout"
+    puts "--------------------------------------------------------------------"
+    puts `sudo fdisk -s #{device_name}`
+    puts
+
+    # Finally detach the image
+    say("Detaching the image file attached to #{device_name}", :blue)
+
+    Geom.detach_image(device_name)
+  end
+
+end

data/lib/actions/mount.rb

@@ -0,0 +1,58 @@
+### Copyright (c) 2012 David Love <david@homeunix.org.uk>
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+### @author David Love
+###
+### Attach an image to the device tree. Creates a device node for an
+### existing image, allowing the image to be accessed using the standard
+### file and disk manipulation commands.
+###
+
+# File handling classes
+require "fs/geom"
+
+class Bake < Thor
+  
+  desc "mount [IMAGE NAME]", "Make an image accessible through the /mnt directories"
+
+  def mount(image_name = "pi.img")
+    say("Attaching image #{image_name}", :blue)
+    
+    device_name = Geom.attach_image(image_name)
+    
+    unless device_name.nil? then
+      say("...Image attached to #{device_name}", :blue)
+    else
+      say("ERROR: Could not attach #{image_name}", :red)
+    end
+    
+    say("Mounting image #{image_name}...", :blue)
+    
+    if Geom.mount_image(device_name) then
+      say("...Image mounted under /mnt", :blue)
+    else
+      say("ERROR: Could not mount #{image_name}", :blue)
+      
+      # try to unmount and detach the failed image
+      unless Geom.umount_image_dirs then
+        say("ERROR: Unable to unmount all the image directories", :red)
+      end
+      unless Geom.detach_image(device_name) then
+        say("ERROR: Failed to detach device #{device_name}", :red)
+      end
+    end
+  end
+
+end