vagrant-nixos 0.0.1 → 0.0.2

data/README.md

@@ -1,22 +1,66 @@
 # NixOS Vagrant Plugin
 
-This plugin makes working with [NixOS](http://nixos.org) guests much easier to work with in [Vagrant](http://www.vagrantup.com) by:
+This plugin makes working with [NixOS](http://nixos.org) guests in [Vagrant](http://www.vagrantup.com) a bit nicer:
 
-* Allowing network configurations from Vagrantfile (Vagrant does not have a default NixOS guest capability)
-* Provide a convention for nixos 
+* Allow network configurations
+* Allow hostname setting
+* Provide nix provisioning
 
-## Usage:
+## Install:
 
 ```bash
 $ vagrant plugin install vagrant-nixos
-...
 ```
 
+## Example Vagrantfile
+
+```ruby
+Vagrant.configure("2") do |config|
+
+	# use a suitable NixOS box
+	config.vm.box = "nixos-14.02-x86_64"
+  	
+  	# set hostname
+  	config.vm.hostname = "nixy"
+  
+  	# Setup networking
+	config.vm.network "public_network", :bridge => 'en1: Wi-Fi (AirPort)'
+	config.vm.network "private_network", :ip => "172.16.16.16"
+
+	# Add the htop package
+	config.vm.provision :nixos, :expression => {
+		environment: {
+			systemPackages: [ :htop ]
+		}
+	}, :NIX_PATH => "/custom/path/to/nixpkgs"
+
+end
+```
+
+In the above `Vagrantfile` example we provision the box using the `:expression` method, which will perform a simple ruby -> nix conversion. `:expression` provisioning creates a nix module that executes with `pkgs` in scope. It is roughly equivilent to the below version that uses the `:inline` method.
+
+```ruby
+	config.vm.provision :nixos, :inline => %{
+		{config, pkgs, ...}: with pkgs; {
+			environment.systemPackages = [ htop ];
+		}
+	}, :NIX_PATH => "/custom/path/to/nixpkgs"
+```
+
+Both examples show the optional configuring of a custom `NIX_PATH` path.
+
+
 ## How it works
 
-In nixos we don't mess around with the files in `/etc` instead we write delarative expressions for the system configuration starting in `/etc/nixos/configuration.nix`.
+In nixos we don't mess around with the files in `/etc` instead we write expressions for the system configuration starting in `/etc/nixos/configuration.nix`.
+
+This plugin sets some ground rules for nixos boxes to keep this configuration clean and provisioning possible.
+
+Box creators should ensure that their `configuration.nix` file imports an nix module `/etc/nixos/vagrant.nix` which will be overwritten by `vagrant-nixos` during `vagrant up` or `vagrant provision`.
+
+See the configuration in our [NixOS packer template](http://github.com/oxdi/nixos) for an example.
 
-This plugin sets some ground rules for nixos boxes to keep this configuration clean.
+## Issues
 
-Box creators should ensure that their `configuration.nix` file imports an empty file `/etc/nixos/vagrant.nix` which will be overwritten by `vagrant-nixos` during `vagrant up` or `vagrant provision` and a `nixos-rebuild switch` will be triggerd.
+It's a bit slow on the initial boot/provision at the moment as it must run nixos-rebuild several times. This is far from ideal I'm sure I'll find a better place to hook in the rebuild step soon.
 

data/lib/vagrant-nixos/cap/change_host_name.rb

@@ -0,0 +1,30 @@
+require 'set'
+require 'tempfile'
+
+
+module VagrantPlugins
+	module Nixos
+		module Cap
+			class ChangeHostName
+				include Vagrant::Util
+
+				def self.nix_module(name)
+					<<-NIX
+						{ config, pkgs, ... }:
+						{
+							networking.hostName = "#{name}";
+						}
+					NIX
+				end
+
+				def self.change_host_name(machine, name)
+					if Nixos.write_config(machine, "vagrant-hostname.nix", nix_module(name))
+						Nixos.rebuild(machine)
+					end
+				end
+
+			end
+		end
+	end
+end
+

data/lib/vagrant-nixos/cap/configure_networks.rb

@@ -11,60 +11,41 @@ module VagrantPlugins
 
 				def self.nix_interface_expr(options)
 					<<-NIX
-		{ 
-			name = "eth#{options[:interface]}";
-          	ipAddress = "#{options[:ip]}";
-          	subnetMask = "#{options[:netmask]}";
-        }
+						{ 
+							name = "eth#{options[:interface]}";
+							ipAddress = "#{options[:ip]}";
+							subnetMask = "#{options[:netmask]}";
+						}
 					NIX
 				end
 
-				def self.nix_interface_module(networks)
+				def self.nix_module(networks)
 					exprs = networks.inject([]) do |exprs, network|
 						# Interfaces without an ip set will fallback to
 						# DHCP if useDHCP is set. So skip them.
-						if network[:ip].empty?
+						if network[:ip].nil? or network[:ip].empty?
 							exprs
 						else
 							exprs << nix_interface_expr(network)
 						end
 					end
 					<<-NIX
-{ config, pkgs, ... }:
-{
-	networking.useDHCP = true;
-	networking.interfaces = [
-		#{exprs.join("\n")}
-	];
-}
+						{ config, pkgs, ... }:
+						{
+							networking.usePredictableInterfaceNames = false;
+							networking.useDHCP = true;
+							networking.interfaces = [
+								#{exprs.join("\n")}
+							];
+						}
 					NIX
 				end
 
 				def self.configure_networks(machine, networks)
-					machine.communicate.tap do |comm|
-						# build the network config
-						conf = nix_interface_module(networks)
-
-			            # Perform the careful dance necessary to reconfigure
-			            # the network interfaces
-			            temp = Tempfile.new("vagrant")
-			            temp.binmode
-			            temp.write(conf)
-			            temp.close
-
-			            puts conf
-
-			            # add the network config
-			            filename = "vagrant-interfaces.nix"
-			            comm.upload(temp.path, "/tmp/#{filename}")
-			            comm.sudo("mv /tmp/#{filename} /etc/nixos/#{filename}")
-
-			            # TODO: check that the network config is referenced in vagrant.nix
-
-			            # cleanup
-			            temp.unlink
-			        end
-			    end
+					if Nixos.write_config(machine, "vagrant-interfaces.nix", nix_module(networks))
+						Nixos.rebuild(machine)
+					end
+				end
 
 			end
 		end

data/lib/vagrant-nixos/config.rb

@@ -0,0 +1,46 @@
+
+module VagrantPlugins
+	module Nixos
+		class Config < Vagrant.plugin("2", :config)
+			attr_accessor :inline
+			attr_accessor :path
+			attr_accessor :expression
+			attr_accessor :NIX_PATH
+
+			def initialize
+				@inline      = UNSET_VALUE
+				@path        = UNSET_VALUE
+				@expression  = UNSET_VALUE
+				@NIX_PATH    = UNSET_VALUE
+			end
+
+			def finalize!
+				@inline      = nil if @inline == UNSET_VALUE
+				@path        = nil if @path == UNSET_VALUE
+				@expression  = nil if @expression == UNSET_VALUE
+				@NIX_PATH    = nil if @NIX_PATH == UNSET_VALUE
+			end
+
+			def expression=(v)
+				@expression = v.to_nix
+			end
+
+			def validate(machine)
+				errors = _detected_errors
+
+				if (path && inline) or (path && expression) or (inline && expression)
+					errors << "You can have one and only one of :path, :expression or :inline for nixos provisioner"
+				elsif !path && !inline && !expression
+					errors << "Missing :inline, :expression or :path for nixos provisioner"
+				end
+
+				if path && !File.exist?(path)
+					errors << "Invalid path #{path}"
+				end
+
+				{ "nixos provisioner" => errors }
+			end
+
+		end
+	end
+end

data/lib/vagrant-nixos/guest.rb

@@ -1,9 +1,13 @@
 module VagrantPlugins
 	module Nixos
 		class Guest < Vagrant.plugin("2", :guest)
+
+			attr_accessor :nix_imports
+
 			def detect?(machine)
 				machine.communicate.test("test -f /etc/nixos/configuration.nix")
 			end
+
 		end
 	end
 end

data/lib/vagrant-nixos/plugin.rb

@@ -12,6 +12,9 @@ end
 
 module VagrantPlugins
 	module Nixos
+
+		@@nix_imports = {}
+
 		class Plugin < Vagrant.plugin("2")
 			name "nixos"
 			description <<-DESC
@@ -28,6 +31,22 @@ module VagrantPlugins
 				Cap::ConfigureNetworks
 			end
 
+			guest_capability("nixos", "change_host_name") do
+				require_relative "cap/change_host_name"
+				Cap::ChangeHostName
+			end
+
+			config :nixos, :provisioner do
+				require_relative "config"
+				Config
+			end
+			
+			provisioner :nixos do
+				require_relative "provisioner"
+				Provisioner
+			end
+
 		end
+
 	end
 end

data/lib/vagrant-nixos/provisioner.rb

@@ -0,0 +1,28 @@
+module VagrantPlugins
+	module Nixos
+		class NixosConfigError < Vagrant::Errors::VagrantError
+		end
+
+		class Provisioner < Vagrant.plugin("2", :provisioner)
+	        # This is the method called when the actual provisioning should be
+	        # done. The communicator is guaranteed to be ready at this point,
+	        # and any shared folders or networks are already setup.
+	        #
+	        # No return value is expected.
+	        def provision
+	        	conf = if @config.inline
+	        		@config.inline
+	        	elsif @config.path
+	        		File.read(@config.path)
+	        	elsif @config.expression
+	        		"{config, pkgs, ...}: with pkgs; #{@config.expression}"
+	        	else
+	        		raise NixosConfigError, "Mising :path, :inline or :expression"
+	        	end
+	        	Nixos.write_config(machine, "vagrant-provision.nix", conf)
+	        	Nixos.rebuild!(machine, @config.NIX_PATH)
+	        end
+	    end
+	end
+end
+

data/lib/vagrant-nixos/util.rb

@@ -0,0 +1,156 @@
+module VagrantPlugins
+	module Nixos
+		##############################################
+		# Not sure if this is legit. But We'll use this module
+		# to store the state of the nix configuration and handle
+		# sending it to the machine.
+		#############################################
+
+		@@imports = {}
+
+		# Send file to machine and report if it changed
+		# See _write_config
+		def self.write_config(machine, filename, conf)
+			include_config(machine, filename)
+			_write_config(machine, filename, conf)
+		end
+
+		# mark a file that should be imported to the main config
+		def self.include_config(machine, filename)
+			if @@imports[machine.id].nil?
+				@@imports[machine.id] = {}
+			end
+			@@imports[machine.id][filename] = true
+		end
+
+		def imports
+		end
+
+		# rebuild the base vagrant.nix configuration
+		def self.rebuild(machine, nix_env=nil)
+			# build 
+			conf = "{ config, pkgs, ... }:\n{"
+			# Add a mock provision file if it is missing as during boot the
+			# provisioning file may not be deployed yet.
+			if !machine.communicate.test("test -f /etc/nixos/vagrant-provision.nix")
+				_write_config(machine, "vagrant-provision.nix", "{ config, pkgs, ... }: {}")
+			end
+			# imports
+			conf_paths = if @@imports[machine.id].nil?
+				[]
+			else
+				@@imports[machine.id].keys.inject([]) do |paths, filename|
+					paths << "./#{filename}"
+				end
+			end
+			conf_paths << "./vagrant-provision.nix"
+			# construct the nix module
+			conf << %{
+				imports = [
+					#{conf_paths.join("\n\t\t")}
+				];
+			}
+			# default NIX_PATH
+			if nix_env
+				conf << %{
+					config.environment.shellInit = ''
+						export NIX_PATH=#{nix_env}:$NIX_PATH
+					'';
+				}
+			end
+			conf << "}"
+			# output / build the config
+			_write_config(machine, "vagrant.nix", conf)
+			rebuild!(machine, nix_env)
+		end
+
+		# just do nixos-rebuild
+		def self.rebuild!(machine, nix_env=nil)
+			rebuild_cmd = "nixos-rebuild switch"
+			rebuild_cmd = "NIX_PATH=#{nix_env}:$NIX_PATH #{rebuild_cmd}" if nix_env
+			machine.communicate.tap do |comm|
+				comm.sudo(rebuild_cmd)
+			end
+		end
+
+		def self.same?(machine, f1, f2)
+			machine.communicate.test("cmp --silent '#{f1}' '#{f2}'")
+		end
+
+		protected
+
+		# Send file to machine.
+		# Returns true if the uploaded file if different from any 
+		# preexisting file, false if the file is indentical
+		def self._write_config(machine, filename, conf)
+			temp = Tempfile.new("vagrant")
+			temp.binmode
+			temp.write(conf)
+			temp.close
+			changed = true
+			machine.communicate.tap do |comm|
+				source = "/tmp/#{filename}"
+				target = "/etc/nixos/#{filename}"
+	            comm.upload(temp.path, source)
+	            if same?(machine, source, target)
+	            	changed = false
+	            else
+	            	comm.sudo("mv '#{source}' '#{target}'")
+	            end
+	        end
+	        return changed
+		end
+	end
+end
+
+#################################################
+# Naughty extending of builtins.
+# Add to_nix functions to convert ruby2nix (ish).
+#################################################
+
+module Nix
+	INDENT_STRING="  "
+end
+
+class Symbol
+	def to_nix(indent = 0)
+		to_s
+	end
+end
+
+class NilClass
+	def to_nix(indent = 0)
+		"null"
+	end
+end
+
+class Hash
+	def to_nix(indent = 0)
+		"{\n" +
+		sort {|a, b| a[0].to_s <=> b[0].to_s}.map do |key, value|
+			raise "Key must be a Symbol, not #{key.class}" unless key.is_a?(Symbol)
+			Nix::INDENT_STRING * (indent + 1)+ key.to_nix +
+			" = " + value.to_nix(indent + 1) + ";"
+		end.join("\n") + "\n" +
+		Nix::INDENT_STRING * indent + "}"
+	end
+end
+
+class Array
+	def to_nix(indent = 0)
+		"[ " + map(&:to_nix).join(" ") + " ]"
+	end
+end
+
+class String
+	def to_nix(indent = 0)
+	    # TODO: escape ${var} in string
+	    "''#{self}''"
+	end
+end
+
+class Fixnum
+	def to_nix(indent = 0)
+	    to_s
+	end
+end

data/lib/vagrant-nixos/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
 	module Nixos
-		VERSION = "0.0.1"
+		VERSION = "0.0.2"
 	end
 end

data/lib/vagrant-nixos.rb

@@ -1,5 +1,6 @@
 require "vagrant-nixos/version"
 require "vagrant-nixos/plugin"
+require "vagrant-nixos/util"
 
 module VagrantPlugins
 	module Nixos

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-nixos
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -57,9 +57,13 @@ files:
 - README.md
 - Rakefile
 - lib/vagrant-nixos.rb
+- lib/vagrant-nixos/cap/change_host_name.rb
 - lib/vagrant-nixos/cap/configure_networks.rb
+- lib/vagrant-nixos/config.rb
 - lib/vagrant-nixos/guest.rb
 - lib/vagrant-nixos/plugin.rb
+- lib/vagrant-nixos/provisioner.rb
+- lib/vagrant-nixos/util.rb
 - lib/vagrant-nixos/version.rb
 - vagrant-nixos.gemspec
 homepage: ''
@@ -77,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 867435977267935838
+      hash: -2672908896929741571
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 867435977267935838
+      hash: -2672908896929741571
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23