pi_build_modifier 0.3.0.pre.alpha → 0.3.1.pre.alpha

data/pi_customizer/envs/aws/variables.tf

@@ -0,0 +1,55 @@
+/** Access key. NOTE: DO NOT CHECK IN */
+variable "access_key" {
+  description = "Access Key"
+}
+
+/** Secret key. NOTE: DO NOT CHECK IN */
+variable "secret_key" {
+  description = "Secret Access"
+}
+
+variable "ssh_path" {
+  description = "Secret Access"
+}
+
+/** AZ which is used by default during the deployment */
+variable "default_az" {
+  description = "Default AZ"
+  default     = "eu-central-1a"
+}
+
+/** Region which is used by default during te rollout */
+variable "region" {
+  description = "AWS region to host the bosh network"
+  default     = "eu-central-1"
+}
+
+variable "vpc_gw" {
+  description = "GW for the vpc"
+  default     = "10.0.0.1"
+}
+
+variable "gateway" {
+  description = "GW for the bosh network"
+  default     = "10.0.1.1"
+}
+
+variable "vpc_cidr" {
+  description = "CIDR for VPC"
+  default     = "10.0.0.0/16"
+}
+
+variable "public_subnet_cidr" {
+  description = "CIDR for public subnet"
+  default     = "10.0.0.0/24"
+}
+
+/* Ubuntu ami by region */
+variable "amis" {
+  type        = "map"
+  description = "Base AMI to launch the vms"
+
+  default = {
+    eu-central-1 = "ami-7f42e510"
+  }
+}

data/pi_customizer/envs/docker/Dockerfile

@@ -0,0 +1,6 @@
+FROM ubuntu:16.04
+RUN apt update
+RUN apt install -y sudo git ruby ruby-dev build-essential \
+        quilt parted realpath qemu-user-static debootstrap zerofree pxz zip \
+        dosfstools bsdtar libcap2-bin grep rsync xz-utils fakeroot curl vim
+CMD ["/sbin/init"]

data/pi_customizer/envs/sh/build-pi-img.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+# Install dependencies
+sudo apt update
+sudo apt -y install parted zerofree dosfstools git quilt qemu-user-static debootstrap pxz zip bsdtar ruby-full libcap2-bin
+
+file="gitpath"
+if [ -f "$file" ]; then
+    git clone "$(< gitpath)"
+fi
+
+cd pi-gen
+echo "IMG_NAME=\"chiipi\"" > config
+
+wpa_supplicant_folder=stage1/02-net-tweaks/files/interfaces
+
+cp ../conf/wpa_supplicant.json ./stage2/02-net-tweaks/rb
+
+touch ./stage3/SKIP ./stage4/SKIP ./stage5/SKIP
+rm stage4/EXPORT* stage5/EXPORT*
+
+# Build it
+gem install bundler
+gem install rake
+gem install rspec
+
+bundle install
+rake pi_gen

data/pi_customizer/lib/pi_customizer/build/builder/build_executor.rb

@@ -0,0 +1,149 @@
+# 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
+# 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_customizer/utils/logex'
+
+module PiCustomizer
+  module Builder
+
+    ##
+    # BuildExecutor triggers the steps of a build process in a given environment (e.g., a vagrant box).
+    # It skips individual steps in the build process when they are defined as skip_build_steps.
+
+    class BuildExecutor
+
+      attr_reader :env, :skip_build_steps
+
+      def initialize(environment, skip_build_steps = Array.new)
+        @env = environment
+        @skip_build_steps = convert_to_skip(skip_build_steps)
+      end
+
+      ##
+      # check if a build environment is specified and then calls the check step for this environment
+
+      def check
+        check_env
+        @env.check
+      end
+
+      ##
+      # execute the prepare step for the build environment
+
+      def prepare
+        unless @skip_build_steps.include?(:prepare)
+          @env.prepare
+        end
+      end
+
+      ##
+      # execute the start step for the build environment
+
+      def start
+        unless @skip_build_steps.include?(:start)
+          @env.start
+        end
+      end
+
+      ##
+      # execute the build_image step for the build environment
+
+      def build_image
+        unless @skip_build_steps.include?(:build_image)
+          @env.build_image
+        end
+      end
+
+      ##
+      # publish the image from the build environment
+
+      def publish
+        unless @skip_build_steps.include?(:publish)
+          @env.publish
+        end
+      end
+
+      ##
+      # clean_up the build environment
+
+      def clean_up
+        unless @skip_build_steps.include?(:clean_up)
+          @env.clean_up
+        end
+      end
+
+      ##
+      # execute the stop step of the environment
+
+      def stop
+        unless @skip_build_steps.include?(:stop)
+          @env.stop
+        end
+      end
+
+      ##
+      # execute the ensure step of an environment
+
+      def ensure
+        @env.ensure
+      end
+
+      ##
+      # convert a list of stringified build steps to a list of symbols
+
+      private def convert_to_skip(skip_build_steps)
+        if skip_build_steps.nil?
+          skip_build_steps = Array.new
+        else
+          # convert every key to a symbol
+          skip_build_steps = skip_build_steps.collect {|k| k.to_sym}
+        end
+        $logger.debug "Skipping the following build steps: #{skip_build_steps}"
+        skip_build_steps
+      end
+
+      ##
+      # check if an environment is specified
+
+      private def check_env
+        if @env.nil?
+          raise 'No environment specified, please specify the "environment", e.g. Vagrant'
+        end
+      end
+    end
+  end
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/pi_customizer/lib/pi_customizer/build/builder/builder.rb

@@ -0,0 +1,59 @@
+# 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
+# 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_customizer/build/builder/build_executor'
+
+module PiCustomizer
+  module Builder
+
+    ##
+    # PiBuilder defines abstractly the steps of a build process.
+    # However, the concrete orchestration of the build process's steps is done by its sub-classes.
+
+    class PiBuilder
+
+      attr_reader :build_executor
+
+      def initialize(environment, skip_build_steps)
+        @build_executor = BuildExecutor.new(environment,skip_build_steps)
+      end
+
+      ##
+      # build orchestrates an environment and therefore the build process of an image
+
+      def build
+        begin
+          execute_builder
+        rescue Exception => e
+          $logger.error e.message
+        ensure
+          ensure_builder
+        end
+      end
+
+      protected def ensure_builder
+      end
+
+      protected def execute_builder
+      end
+
+    end
+  end
+end

data/pi_customizer/lib/pi_customizer/build/builder/prepare_start_execute_builder.rb

@@ -0,0 +1,43 @@
+# 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
+# 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_customizer/build/builder/builder'
+
+module PiCustomizer
+  module Builder
+    class PrepareExecuteBuilder < PiBuilder
+
+      protected def execute_builder
+        @build_executor.check
+        @build_executor.prepare
+        @build_executor.publish
+        @build_executor.clean_up
+        @build_executor.start
+        @build_executor.build_image
+        @build_executor.stop
+      end
+
+      protected def ensure_builder
+        @build_executor.ensure
+      end
+
+    end
+  end
+end

data/pi_customizer/lib/pi_customizer/build/builder/start_prepare_execute_builder.rb

@@ -0,0 +1,43 @@
+# 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
+# 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_customizer/build/builder/builder'
+
+module PiCustomizer
+  module Builder
+    class StartExecuteBuilder < PiBuilder
+
+      protected def execute_builder
+        @build_executor.check
+        @build_executor.start
+        @build_executor.prepare
+        @build_executor.build_image
+        @build_executor.publish
+        @build_executor.clean_up
+        @build_executor.stop
+      end
+
+      protected def ensure_builder
+        @build_executor.ensure
+      end
+
+    end
+  end
+end

data/pi_customizer/lib/pi_customizer/build/environment/aws/aws.rb

@@ -0,0 +1,76 @@
+# 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
+# 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 'fileutils'
+require 'pi_customizer/utils/logex'
+require 'pi_customizer/build/environment/environment'
+
+module PiCustomizer
+  module Environment
+    class AWS < EnvironmentControl
+
+      def build
+
+        puts 'NOTE: AWS is not yet officially supported!'
+
+        create_ssh_folder
+        create_keys
+        begin
+          terraform
+        ensure
+          del_keys
+        end
+      end
+
+      def terraform
+        puts 'Build env with terraform'
+        Dir.chdir 'envs/aws' do
+          system 'terraform plan'
+          system 'terraform apply'
+        end
+      end
+
+      def create_keys(key_name = 'pi-builder')
+        $logger.info 'Create AWS key unless it exists'
+        FileUtils.mkdir_p 'ssh'
+        unless File.file?("ssh/#{key_name}.pub")
+          system "ssh-keygen -t rsa -C pi-builder -P '' -f ssh/#{key_name} -b 4096"
+          FileUtils.mv "ssh/#{key_name}", "ssh/#{key_name}.pem"
+          FileUtils.chmod 400, "ssh/#{key_name}.pem"
+        end
+      end
+
+      def del_keys(key_name = 'pi-builder')
+        if File.file?("ssh/#{key_name}.pub")
+          FileUtils.rm "ssh/#{key_name}.pub"
+        end
+        if File.file?("ssh/#{key_name}.pem")
+          FileUtils.rm "ssh/#{key_name}.pem"
+        end
+      end
+
+      def create_ssh_folder
+        unless File.directory?('ssh')
+          FileUtils.mkdir_p 'ssh'
+        end
+      end
+    end
+  end
+end

data/pi_customizer/lib/pi_customizer/build/environment/docker/docker.rb

@@ -0,0 +1,94 @@
+# 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
+# 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_customizer/utils/logex'
+
+module PiCustomizer
+  module Environment
+    class Docker < EnvironmentControl
+
+      DOCKERFILE_PATH = File.join(File.dirname(__FILE__), '/../../../../envs/docker')
+      DOCKERFILE = "#{DOCKERFILE_PATH}/Dockerfile"
+      CONFIG_PATH_IN_DOCKER = '/resources'
+
+      def check
+
+        puts 'NOTE: Docker is not yet officially supported!'
+
+        $logger.info '[Check | Docker] Pre-flight checks are executing...'
+        ensure_docker
+      end
+
+      def start
+        $logger.info "[Start | Docker] Build docker image: #{DOCKERFILE}"
+        system "docker build --rm=true --file=#{DOCKERFILE} --tag=pi:build #{DOCKERFILE_PATH}"
+        $logger.info "[Start | Docker] Start docker image with volume #{@config.tmp_directory}:#{@workspace.workspace_directory}"
+        system "sudo docker run -v #{@config.tmp_directory}:#{@workspace.workspace_directory}:rw -v /dev:/dev -v /lib/modules:/lib/modules --cap-add=ALL --privileged=true --detach  --security-opt label:disable pi:build \"/sbin/init\" > cid"
+      end
+
+      def prepare
+        prepare_workspace
+        prepare_configuration
+      end
+
+      def build_image
+        $logger.info '[Build| Docker] customization of build sources'
+        system "sudo docker exec --tty \"$(cat cid)\" bash -c \"sudo pi_build_modifier modify #{CONFIG_PATH_IN_DOCKER}/resources.json #{@workspace.workspace_directory}\""
+        $logger.info '[Build| Docker] pi-image build step'
+        system "sudo docker exec --tty \"$(cat cid)\" bash -c \"cd #{@workspace.workspace_directory} && sudo ./build.sh\"" #sudo chown docker #{@workspace.workspace_directory} &&
+      end
+
+      def clean_up
+        $logger.info '[Clean Up | Docker] pi-image remove contents of temporary container'
+      end
+
+      def stop
+        $logger.info '[Stop | Docker] Stop pi:build container'
+        #system 'docker stop "$(cat cid)"'
+        $logger.info '[Stop | Docker] RM pi:build container'
+        #system 'docker rm "$(cat cid)"'
+        #TODO: rm cid file!
+      end
+
+      private def ensure_docker
+        unless system 'docker -v'
+          raise 'Docker is not installed. Please ensure that Docker is running.'
+        end
+      end
+
+      private def prepare_configuration
+        $logger.info "[Prepare | Docker] Copy the configuration file from #{@config.config_path} to #{CONFIG_PATH_IN_DOCKER}/resources.json in container"
+        system "docker exec --tty \"$(cat cid)\" bash -c \"sudo mkdir -p #{CONFIG_PATH_IN_DOCKER}\""
+        system "docker cp #{@config.config_path} \"$(cat cid)\":#{CONFIG_PATH_IN_DOCKER}/resources.json"
+        gem_path = File.join(File.dirname(__FILE__), '/../../../../envs/pi_build_modifier.gem')
+        system "docker cp #{gem_path} \"$(cat cid)\":#{CONFIG_PATH_IN_DOCKER}/pi_build_modifier.gem"
+        system "docker exec --tty \"$(cat cid)\" bash -c \"sudo gem install #{CONFIG_PATH_IN_DOCKER}/pi_build_modifier.gem\""
+      end
+
+      private def prepare_workspace
+        $logger.info "[Prepare | Docker] Clone git project: #{@workspace}"
+        system "docker exec --tty \"$(cat cid)\" bash -c \"sudo mkdir -p #{@workspace.workspace_directory}\""
+        #TODO: git clone vs git pull when code exists...
+        system "docker exec --tty \"$(cat cid)\" bash -c \"sudo git clone #{@workspace.git_path} #{@workspace.workspace_directory}\""
+      end
+
+    end
+  end
+end

data/pi_customizer/lib/pi_customizer/build/environment/environment.rb

@@ -0,0 +1,73 @@
+# 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
+# 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_customizer/utils/logex'
+
+module PiCustomizer
+  module Environment
+
+    ##
+    # EnvironmentControl defines the build steps that must be supported for a concrete environment
+
+    class EnvironmentControl
+
+      attr_reader :workspace, :config
+
+      def initialize(remote_workspace, local_workspace)
+        @workspace = remote_workspace
+        @config = local_workspace
+      end
+
+      def check
+        $logger.warn '[Check] skipped...'
+      end
+
+      def prepare
+        $logger.warn '[Prepare] skipped...'
+      end
+
+      def start
+        $logger.warn '[Start] skipped...'
+      end
+
+      def build_image
+        $logger.warn '[Build Image] skipped...'
+      end
+
+      def publish
+        $logger.warn '[Publish] skipped...'
+      end
+
+      def clean_up
+        $logger.warn '[Clean up] skipped...'
+      end
+
+      def stop
+        $logger.warn '[Stop] skipped...'
+      end
+
+      def ensure
+        $logger.info '[Ensure] skipped...'
+      end
+
+    end
+  end
+end
+