pi_build_modifier 0.2.0.pre.alpha → 0.3.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2166dffe358e62ffec35a50e83528f06ac2c543b
-  data.tar.gz: 737ac930c588b69ab8baf430837022370274db13
+SHA256:
+  metadata.gz: 73f4b122a82fabf9a45f80014362373898ea1ab674d582b0e5526c8df6a0a246
+  data.tar.gz: 7ccee60700c56c80fa4a29d2d6c20f751613f8a8507d37fcc25406ebe0c26c80
 SHA512:
-  metadata.gz: 055c01e36cdb9ae6473cd5598567470d034541115f1a8ed8be207fa7ef284cfaabcefbeff7e2fd639adccf1af5a640a6cc45c802a4d57cd68d32fbecc4b2527d
-  data.tar.gz: 4705763b3e1c33c7b0397a088316c59f99e48933628b99f4bc18b354b9d342522da96e75beea63cae959bfbde93a78063579691d56429f106bd3e0b3d80b6163
+  metadata.gz: 2252b2ec71bef888528a79d18a9ba225a29b2073aa08cce69f3d0bc23a06ceca5d4c11861abcdca0c4a647cdad840177b5e59d26ea30eda18841cfa239ac4cda
+  data.tar.gz: 485e73884692ffd73d3d8b350afeffe4b8dd5d569f8207bd6e35daa154a111e7c0ed674eb596939ad7b0cc8de840ead3cf051d36fe2ba630bc585de0db38fcd9

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Beate Ottenwälder
+Copyright (c) 2017-2018 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/bin/pi_build_modifier

@@ -1,5 +1,25 @@
 #!/usr/bin/env ruby
 
+# Copyright (c) 2017-2018 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 require 'pi_build_modifier'
 
 PiBuildModifier::PiBuildModifier.start(ARGV)

data/lib/pi_build_modifier/boot-files/boot.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -24,7 +24,7 @@ require 'json'
 module PiBuildModifier
 
   ##
-  # The Locale class is used to customize the locales
+  # The Locale class is used to customize locales
 
   class Boot
 
@@ -49,7 +49,7 @@ module PiBuildModifier
     def map(json_data)
       unless json_data.nil? || !json_data.has_key?(C_GROUPS)
         if json_data[C_GROUPS].has_key?(C_GROUP_MEMORY) && json_data[C_GROUPS][C_GROUP_MEMORY]
-          @c_groups << 'cgroup_memory=1'
+          @c_groups << 'cgroup_enable=memory cgroup_memory=1 swapaccount=1'
         end
       end
     end

data/lib/pi_build_modifier/config/logex.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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/lib/pi_build_modifier/locale/locale_debconf.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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/lib/pi_build_modifier/locale/templates/00-debconf.erb

@@ -3,4 +3,4 @@
 locales	locales/locales_to_be_generated	multiselect	<%= @gen_locales.join(', ') %>
 # Default locale for the system environment:
 # Choices: None, C.UTF-8, en_GB.UTF-8
-locales	locales/default_environment_locale	select	<%= @sys_locale %>
+locales	locales/default_environmentg_locale  <select name="" id=""></select>	<%= @sys_locale %>

data/lib/pi_build_modifier/modifier/erb_mapper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -35,6 +35,10 @@ module PiBuildModifier
       @output_path = working_dir + '/' + @data.relative_output_path
     end
 
+    def check(json_data)
+      @data.check(json_data)
+    end
+
     def map(json_data)
       @data.map(json_data)
     end

data/lib/pi_build_modifier/modifier/mapper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -21,8 +21,9 @@
 module PiBuildModifier
 
   ##
-  # Mapper represents an abstract class that is used by the modifier to call the necessary steps in order to map values
-  # to an object and then modify it
+  # Mapper represents a container that is used by the pi_build_modifier to call
+  # the necessary steps to modify a build configuration.
+  # It triggers check, mapping, and modification steps for one build configuration.
 
   class Mapper
 
@@ -32,6 +33,10 @@ module PiBuildModifier
       @data = data
     end
 
+    def check(json_data)
+      @data.check(json_data) unless @data.nil?
+    end
+
     def map(json_data)
       @data.map(json_data) unless @data.nil?
     end

data/lib/pi_build_modifier/modifier/pi_modifier.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -43,8 +43,9 @@ module PiBuildModifier
       end
     end
 
-    def modify
+    def modify(do_check = false)
       load_config
+      check_all if do_check
       map_all
       modify_all
     end
@@ -59,15 +60,21 @@ module PiBuildModifier
       end
     end
 
+    private def check_all
+      @mappers.each do |mapper|
+        mapper.check(@json_data)
+      end
+    end
+
     private def map_all
-      @mappers.each do |c|
-        c.map(@json_data)
+      @mappers.each do |mapper|
+        mapper.map(@json_data)
       end
     end
 
     private def modify_all
-      @mappers.each do |c|
-        c.modify
+      @mappers.each do |mapper|
+        mapper.modify
       end
     end
   end

data/lib/pi_build_modifier/modifier_task.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -29,6 +29,12 @@ require 'pi_build_modifier/boot-files/boot'
 
 module PiBuildModifier
   module Task
+
+    ##
+    # Modifier triggers all changes specified in the config. To this end,
+    # it configures and calls specialized mappers which map the config to
+    # the the individual pi-gen build scripts.
+
     class Modifier
 
       attr_reader :pi_modifier

data/lib/pi_build_modifier/net-tweaks/wifi_network.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -50,14 +50,20 @@ module PiBuildModifier
 
   class WPASupplicant
 
-    PASSKEY = 'passphrase'
+    PASSPHRASE = 'passphrase'
 
-    WPA_PASSKEY = 'wpa_passphrase'
+    WPA_PASSPHRASE = 'wpa_passphrase'
 
     SSID = 'ssid'
 
     attr_reader :template_path, :relative_output_path
 
+    ##
+    # By default, WPASupplicant is configured with:
+    # wpa_country:  DE
+    # template:     './templates/wpa_supplicant.conf.erb'
+    # output path:  'stage2/02-net-tweaks/files/wpa_supplicant.conf'
+
     def initialize
       @networks = map_network(nil)
       @wpa_country = 'DE'
@@ -69,6 +75,16 @@ module PiBuildModifier
       ERBMapper.new(self, workspace)
     end
 
+    #TODO: test
+    def check(json_data)
+      unless File.file?(@relative_output_path)
+        raise "File #{relative_output_path} does not exist"
+      end
+    end
+
+    ##
+    # map the 'wifi' section in the json configuration to the instance variables.
+
     def map(json_data)
       unless json_data.nil?
         @networks = map_network(json_data['wifi']) if json_data.has_key?('wifi')
@@ -77,7 +93,7 @@ module PiBuildModifier
     end
 
     private def map_network(json_data)
-      if json_data.nil?
+      if json_data.nil? or not json_data.has_key?('networks')
         networks = Array.new(0)
       else
         networks = json_data['networks'].map do |rd|
@@ -86,10 +102,10 @@ module PiBuildModifier
                  else
                    'no_ssid'
                  end
-          psk = if rd.has_key?(PASSKEY)
-                  OpenSSL::PKCS5.pbkdf2_hmac_sha1(rd[PASSKEY], ssid, 4096, 32).unpack("H*").first
-                elsif rd.has_key?(WPA_PASSKEY)
-                  rd[WPA_PASSKEY]
+          psk = if rd.has_key?(PASSPHRASE)
+                  OpenSSL::PKCS5.pbkdf2_hmac_sha1(rd[PASSPHRASE], ssid, 4096, 32).unpack("H*").first
+                elsif rd.has_key?(WPA_PASSPHRASE)
+                  rd[WPA_PASSPHRASE]
                 else
                   'no_psk'
                 end

data/lib/pi_build_modifier/sys_tweaks/run_modifier.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -25,7 +25,8 @@ require 'pi_build_modifier/modifier/mapper'
 module PiBuildModifier
 
   ##
-  # RunModifier is a class which appends lines to the 'stage2/01-sys-tweaks/01-run.sh' file in the pi gen build repository
+  # RunModifier is a class which appends lines to the sys-tweaks run file in the pi-gen build directory.
+  # By default this is the file 'stage2/01-sys-tweaks/01-run.sh'.
 
   class RunModifier < Mapper
 
@@ -46,6 +47,9 @@ module PiBuildModifier
       @appender << appender
     end
 
+    ##
+    # modify the sys-tweaks run file by adding lines at the end of the file
+
     def modify
       open("#{@workspace}/#{@relative_output_path}", 'a') do |f|
         f.puts ''

data/lib/pi_build_modifier/sys_tweaks/ssh.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -49,7 +49,7 @@ module PiBuildModifier
       unless json_data.nil?
         @enable = 'disable' if json_data.has_key?('ssh') && json_data['ssh'].has_key?('enabled') && (not json_data['ssh']['enabled'])
       else
-        $logger.error 'Invalid json data.'
+        $logger.error 'Ssh could not be configured: Invalid json data.'
       end
     end
 

data/lib/pi_build_modifier/system/system_type.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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/lib/pi_build_modifier/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -19,5 +19,5 @@
 # SOFTWARE.
 
 module PiBuildModifier
-  VERSION = '0.2.0-alpha'
+  VERSION = '0.3.0-alpha'
 end

data/lib/pi_build_modifier.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -34,11 +34,14 @@ module PiBuildModifier
 
     desc 'modify CONFIG WORKSPACE', 'Modify the pi image sources at the specified WORKSPACE with the specified configuration file CONFIG.'
     def modify(config, workspace)
-      $logger.debug "modify #{config} #{workspace}"
+      $logger.debug "Modifying with a configuration read from '#{config}' in the workspace '#{workspace}'"
       task = Task::Modifier.new(config, workspace)
       task.execute
     end
 
+    ##
+    # The version command allows users to query for the current version of the pi_customizer gem. It is printed on the command line.
+
     desc 'v, version', 'Show the version of the modifier.'
     def version
       puts VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pi_build_modifier
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.alpha
+  version: 0.3.0.pre.alpha
 platform: ruby
 authors:
 - Beate Ottenwälder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Modify builds of Raspbian images.