pi_customizer 0.3.0.pre.alpha → 0.3.1.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c957ade234bf33cbd7349481dd2c37cc1353879cb8be72cb8ee065bc68c89e8
-  data.tar.gz: 5189286585e7181067bfdc4e239abbd82048091a0cba2b9579f92ff2fb590f48
+  metadata.gz: 6f6d39d92c9687e995afff15c67c0052350c762117c6228bb69e56fb31b3806d
+  data.tar.gz: 2471722c474661111d0b1cc2ccc2fe8a5780fec56f7d0b47cc271c0c09744f93
 SHA512:
-  metadata.gz: 39c92af0b676abdb9a09a8fa42d79f7c481c4d7be085ac7564b06f615b4f7f6bcbf002605da10ce187fcb5ae9586299981f9c453e190a68afba2cb51decf1a5d
-  data.tar.gz: 1961c5d1fe08a80d5e02a444892086942bbb94c6a1abc1272f53f9b466b5b9be6121ef7800cd6ae5ef888aa12c3f7a0708ab9d5ebe1023a2c2505859f3ecc459
+  metadata.gz: 40de09bc5b2855e944fd93adb50f26039a5c590261a8ddfcf5f7d18193ca5fff3d643b0f5c07af0df698bf009597689b36854910a35b5ce2d3975802157cf3ae
+  data.tar.gz: d9b3deb83f0f517419ec16a0656ce1e23b5d2d64df6c131c5d1f06917d82b5eb09e689ae07f5e09bee2459c6b543ced5861f5c98b3011e08ba54d7db805e2e97

data/.gitignore

@@ -0,0 +1,24 @@
+# Compiled files
+*.tfstate
+*.tfstate.backup
+*.tfvars
+
+# Module directory
+.terraform/
+.idea/
+
+# Project files and direcotires
+*iml
+ssh/
+
+*.conf
+wpa_supplicant.json
+.vagrant/
+Gemfile.lock
+*gem
+
+cid
+coverage/
+tmp/
+*.log
+doc/

data/.travis.yml

@@ -0,0 +1,28 @@
+language: ruby
+rvm:
+- 2.6.3
+- 2.5.5
+- 2.4.6
+before_script:
+- gem install bundler
+- cd pi_customizer/ && bundle install && cd ..
+- cd pi_build_modifier/ && bundle install && cd ..
+script:
+- rake spec
+deploy:
+  - provider: rubygems
+    gem: pi_customizer
+    gemspec: pi_customizer/pi_customizer.gemspec
+    on:
+      branch: development
+      ruby: 2.6.3
+    api_key:
+      secure: V2bkBW+4UT/8Pt+MK6XZwDL5dPF3bkTL1RevI3UCIGmHSoKPPT918DpXhfVg6cRdOhMyYTbTjkQIyP9LEW5Uy8Nozp15kKa2nZbWIuDIIhUPopuymSW1x+g7c7VBU7nU7KL2XsYKwY2+PGp5WUycsWrKyM0U/4tn5wKK4u8lHz6fjmsIldl2/6nEsN23voat2LoftFzG3bng07v/mREjkiLtMzXnZ/sQ/uvC+4W5h3xJUf+KQ86JwoaBrisms5ETkOt3ox3/J56VFcTHi3QbpSW6MXnuKkiohTRkz1CI7V5jLyNKxJn/ZUSZmmKkCvOC2g9J9KzaTey36Iy+eKo2mYBNj59qrUzxChwpcU2peFhpIYfVx+9vQ2ki6h3FtAuTDQ7civ+s/BLAwTPdA64JoLjkYdIhOzsSN61rxsEQOXOz/mih21cPDADWiPOawvC8w6fW3Vf6Pg9etux9pzTpFr41F45e54ZOg074KpUCwk3vMMfZnyF0UbAR/wW5YjAEMA3VYffyT34uisrsmhHjbk3EhpuHIZeJy5ukOeKC2SDmOY6fIbi+rKGLwExj/okIpxVhhBp/bl59Qk4fNvBM81WbxqiuOGafTNWty5Hz1pLqO/1xllDU9eFEpd0jVcBTAAFvSmzYllBg/7R3BXDJyawmhVQZDFAkqtCQ6VOnOl0=
+  - provider: rubygems
+    gem: pi_build_modifier
+    gemspec: pi_build_modifier/pi_build_modifier.gemspec
+    on:
+      branch: development
+      ruby: 2.6.3
+    api_key:
+      secure: V2bkBW+4UT/8Pt+MK6XZwDL5dPF3bkTL1RevI3UCIGmHSoKPPT918DpXhfVg6cRdOhMyYTbTjkQIyP9LEW5Uy8Nozp15kKa2nZbWIuDIIhUPopuymSW1x+g7c7VBU7nU7KL2XsYKwY2+PGp5WUycsWrKyM0U/4tn5wKK4u8lHz6fjmsIldl2/6nEsN23voat2LoftFzG3bng07v/mREjkiLtMzXnZ/sQ/uvC+4W5h3xJUf+KQ86JwoaBrisms5ETkOt3ox3/J56VFcTHi3QbpSW6MXnuKkiohTRkz1CI7V5jLyNKxJn/ZUSZmmKkCvOC2g9J9KzaTey36Iy+eKo2mYBNj59qrUzxChwpcU2peFhpIYfVx+9vQ2ki6h3FtAuTDQ7civ+s/BLAwTPdA64JoLjkYdIhOzsSN61rxsEQOXOz/mih21cPDADWiPOawvC8w6fW3Vf6Pg9etux9pzTpFr41F45e54ZOg074KpUCwk3vMMfZnyF0UbAR/wW5YjAEMA3VYffyT34uisrsmhHjbk3EhpuHIZeJy5ukOeKC2SDmOY6fIbi+rKGLwExj/okIpxVhhBp/bl59Qk4fNvBM81WbxqiuOGafTNWty5Hz1pLqO/1xllDU9eFEpd0jVcBTAAFvSmzYllBg/7R3BXDJyawmhVQZDFAkqtCQ6VOnOl0=

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at b.ottenwaelder@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2018 Beate Ottenwälder
+Copyright (c) 2017-2019 Beate Ottenwälder
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,3 +1,209 @@
-# pi-gen-environment
+# pi-customizer
 
-see https://github.com/ottenwbe/pi-gen-environment
+[![Build Status](https://travis-ci.org/ottenwbe/pi-gen-environment.svg?branch=master)](https://travis-ci.org/ottenwbe/pi-gen-environment)
+
+|Gem                |Badge      |
+|:-:|:-:|
+| pi_customizer     | [![Gem Version](https://badge.fury.io/rb/pi_customizer.svg)](https://badge.fury.io/rb/pi_customizer)  | 
+| pi_build_modifier | [![Gem Version](https://badge.fury.io/rb/pi_build_modifier.svg)](https://badge.fury.io/rb/pi_build_modifier)  | 
+
+
+The _pi_customizer_ allows you to adapt Raspbian images to your needs.
+To this end, the Raspbian image is be built from [scratch](https://github.com/ottenwbe/pi-gen.git) 
+with all customizations baked into the image. 
+
+The image is built in an isolated [build environment](#environments), e.g., 
+a vagrant box, which is orchestrated by the pi_customizer.
+The customization is performed by a Ruby Gem (_pi_build_modifier_) in the build environment by adapting the [pi-gen](https://github.com/RPi-Distro/pi-gen) build scripts.
+
+
+# WIP Notice
+
+This project is still under construction and in a pre release phase.
+
+# Install
+
+## Prerequisites
+
+To customize the build process the following prerequisites are expected:
+* The _pi_customizer_ gem is installed (see the [__Deploy Gem__](#deploy_gem) section for details) 
+* One of the supported build environments is accessible (see the [__Environments__](#environments) section):  
+    * Vagrant 
+    * Docker (feature is still in development)    
+
+<a name="deploy_gem"></a>
+## Deploy Gem
+
+To customize your Raspbian image the pi_customizer gem must be installed on the machine that coordinates the build process.
+This is typically your local machine.
+
+1. Install the latest (pre) release. For all prerequisites see the corresponding section. 
+
+    ```bash
+    gem install pi_customizer --pre
+    ```
+    
+1. Verify the installation
+    
+    ```bash
+    pi_customizer version
+    ```
+<a name="environments"></a>
+## Environments
+
+You may choose to build your pi image in a Vagrant box.
+In the future Docker containers will also be supported.
+
+### Vagrant
+
+1. Install Vagrant. For instance, on Fedora:
+
+    ```bash
+    sudo dnf install vagrant
+    ```
+
+1. Verify that vagrant is installed
+    
+    ```
+    vagrant -v
+    ```        
+
+1. Install the `vagrant-disksize` plugin
+    
+    ```
+    vagrant plugin install vagrant-disksize
+    ```        
+
+### Docker
+
+Note: feature still in development
+
+Docker uses a temporary folder as volume to build the image. 
+The folder location can be changed with the build option __tmp-folder__, which is set to "${PWD}/tmp" by default.
+
+Note: the type of the tmp directory needs to be changed on SELinux
+
+    chcon -Rt svirt_sandbox_file_t "${PWD}/tmp"
+    
+After the image is built, undo the changes.    
+    
+    restorecon -v "${PWD}/tmp"
+
+
+# Usage
+
+To build a default image in a Vagrant box, simply execute on the command line
+
+    pi_customizer build VAGRANT -c <your-config-file>
+
+
+To customize your build:
+1. All customizations have to be specified in a json configuration file (see the [__Config File__](#config_file) section for details).
+1. The build process itself is then configured with command line options (see `pi_customizer help build` for details)   
+     
+
+<a name="config_file"></a>
+## Config File
+
+An example of the json config file with all current configuration options
+
+    {
+      "system": {
+        "name" : "custompi",
+        "type" : "lite"
+      },
+      "ssh" : {
+        "enabled" : true
+      },
+      "locale": {
+        "gen" : ["en_GB.UTF-8 UTF-8", "de_DE.UTF-8 UTF-8"],
+        "sys" : "en_GB.UTF-8"
+      },
+      "cgroups": {
+        "memory": true
+      },
+      "wifi": {
+        "networks": [
+          {
+            "ssid": "your_ssid",            
+            "passphrase": "your_secret_psk" // Alternative: "wpa_passphrase": "your_wpa_passpharse"
+          }
+        ],
+        "wpa_country": "DE"
+      }
+    }
+
+### The system section
+
+* To choose a custom name for your pi image, specify the __name__ value. The default is _custompi_.
+
+* To build a lite version of the pi image, specify the __type__ as lite, otherwise specify it as full. The default is _full_.
+
+### The ssh section
+
+* To disable ssh by default, set __enabled__ to false.
+
+### The locale section
+
+* Select one or more locales to be generated: e.g., "en_GB.UTF-8 UTF-8", "de_DE.UTF-8 UTF-8", ...
+* Select the default locale, typically en_GB.UTF-8, which is the default.
+
+### The cgroups section
+
+* To enable the cgroup memory, enable __memory__, otherwise leave it out.
+
+### The wifi section
+
+* The wifi section allows you to specify networks and passphrase __OR__ wpa_passpharse as well as the wpa_country.
+
+# Development
+
+### Prerequisites
+
+* Make sure Ruby is installed (and dependencies to build native extensions). See, https://github.com/rbenv/rbenv and https://github.com/rbenv/ruby-build.
+
+  * On Fedora with zsh, this means sth. along the lines of:
+
+    ```
+    sudo dnf group install "C Development Tools and Libraries"
+    sudo dnf install redhat-rpm-config git openssl-devel readline-devel
+    
+    git clone https://github.com/rbenv/rbenv.git ~/.rbenv
+    echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.zshrc
+    ~/.rbenv/bin/rbenv init
+    exec $SHELL
+
+    git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
+    echo 'export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH"' >> ~/.zshrc
+    exec $SHELL
+    
+    rbenv install 2.5.5
+    rbenv global 2.5.5
+    ```
+
+
+* Install Gems    
+
+    ```
+    gem install bundler rake rspec rdoc
+    ```    
+
+## Test
+
+RSpec tests can be executed for all modules by calling the following rake command in the project root.
+
+    rake spec
+
+## Structure
+
+For now, the sources of both gems (pi_customizer and pi_build_modifier) are versioned in one repository. 
+This might change if their versions run out of sync.  
+    
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ottenwbe/pi-gen-environment. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+    
+## License
+
+The gems are available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+    

data/Rakefile

@@ -1,13 +1,141 @@
-lib = File.join(File.dirname(__FILE__), '/lib')
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+PI_CUSTOMIZER = 'pi_customizer'
+PI_BUILD_MODIFIER = 'pi_build_modifier'
+
+build_projects = [PI_BUILD_MODIFIER]
+install_projects = [PI_CUSTOMIZER]
+all_gems = (build_projects + install_projects).uniq
+files = %w(pi_build_modifier/lib/**/*.rb pi_customizer/lib/**/*.rb)
+
+##
+# The spec task executes rspec tests for all gems of the pi_customizer project.
+# This task is executed by default when 'rake' is called on the command line
 
 begin
-  require 'bundler/gem_tasks'
   require 'rspec/core/rake_task'
 
-  RSpec::Core::RakeTask.new(:spec)
-  task :default => :spec
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    # find all spec files (for all gems)
+    pattern = ''
+    all_gems.each do |gem|
+      if pattern == ''
+        pattern = "#{gem}/spec/**{,/*/**}/*_spec.rb"
+      else
+        pattern = pattern + ',' + "#{gem}/spec/**{,/*/**}/*_spec.rb"
+      end
+    end
+    # tell rspec to execute tests on all spec files
+    t.pattern = pattern
+  end
+rescue LoadError
+  puts 'RSpec is not installed. This means rake is not able to execute tests! '
+  puts '* Try: gem install rspec'
+end
+
+task :default => :spec
+
+
+# release task
+
+desc 'Release and upload to Rubygems.org'
+task :release do
+  all_gems.each do |p|
+    Dir.chdir p do
+      system 'rake release'
+    end
+  end
+end
+
+# doc tasks
+
+begin
+  require 'rdoc/task'
 
+  RDoc::Task.new do |rdoc|
+    rdoc.rdoc_dir = File.join(File.dirname(__FILE__), '/doc')
+    rdoc.rdoc_files.include(files)
+  end
 rescue LoadError
-  puts 'RSpec or Bundler is not installed. This means rake is not able to execute tests!'
+  puts 'RSpec is not installed. This means rake is not able to build the documentation!'
+  puts '* Try: gem install rdoc'
 end
+
+# version tasks
+
+desc "Show the gem's versions"
+task :versions do
+  require_relative "#{PI_CUSTOMIZER}/lib/#{PI_CUSTOMIZER}/version"
+  puts "#{PI_CUSTOMIZER} Versions"  
+  puts ' '
+  puts '*** Dev VERSION ***'
+  puts ' '
+  puts "#{PI_CUSTOMIZER}: #{PiCustomizer::VERSION} "
+  system "gem list #{PI_CUSTOMIZER} --pre --remote"  
+  puts ' '
+  require_relative "#{PI_BUILD_MODIFIER}/lib/#{PI_BUILD_MODIFIER}/version"  
+  puts "#{PI_BUILD_MODIFIER} Versions"
+  puts ' '
+  puts '*** Dev VERSION ***'
+  puts ' '
+  puts "#{PI_BUILD_MODIFIER}: #{PiBuildModifier::VERSION}"
+  system "gem list #{PI_BUILD_MODIFIER} --pre --remote"  
+end
+
+# build tasks
+
+desc "Build all gems (i.e., #{PI_BUILD_MODIFIER} and #{PI_CUSTOMIZER})"
+task :build do
+  all_gems.each do |p|
+    Dir.chdir p do
+      system 'rake build'
+    end
+  end
+end
+
+namespace :uninstall do
+  desc 'remove the locally required gems'
+  task :local do
+    install_projects.each do |p|
+      Dir.chdir p do
+        system "gem uninstall #{p} -a -x"
+      end
+    end
+  end
+end
+
+namespace :install do
+
+  require 'fileutils'
+
+  desc 'install the locally required gems'
+  task :local do
+    build_projects.each do |p|
+      Dir.chdir p do
+        system 'rake build'
+      end
+    end
+    install_projects.each do |p|
+      Dir.chdir p do
+        system 'rake install:local'
+      end
+    end
+  end
+
+  task :local => [:spec, :rdoc, 'uninstall:local']
+
+end
+
+# run the pi_customizer from source
+
+namespace :run do
+
+  desc 'run the pi_customizer and build the pi image in a vagrant box'
+  task :vagrant, [:resources] do |t, args|
+    system ("ruby pi_customizer/bin/pi_customizer build VAGRANT #{args[:resources]}")
+  end
+
+  desc 'run the pi_customizer and build the pi image in a docker container'
+  task :docker, [:resources] do |t, args|
+    system ("ruby pi_customizer/bin/pi_customizer build DOCKER #{args[:resources]}")
+  end
+
+end