bake-toolkit 2.26.1 → 2.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59e3d776eb440f434be50c4e0c1c3b1052d1a78f
-  data.tar.gz: dbcec7eea7c0569850cdc9a3648daad825733b56
+  metadata.gz: e0e1f90912811da36dbf1370d42792187d92ad06
+  data.tar.gz: f3b95ad81adb8298b0ac6bbc2efd1527a797a276
 SHA512:
-  metadata.gz: 566277aeca80053e87309f85bd710a4f294e9dd113675155447fcc9d18a597847ecbe65a8f197d5d35c7a451fbef69836330ef1874f31b0bb3216da2c48af1dc
-  data.tar.gz: 799067a3a8f587f6a356d31f023c479696f6d4e4134381bdeaffe99cc59d2f9151c15a2a487eb988762fa4556cce7a815129c11fb8207ae3b666a97be82da8aa
+  metadata.gz: 189d2546359dcd6469d9780f70d753c73875f4ed382697e3ea9214fc139f3c10aece6baa9ffac3f54dfd824a4e14e4bb926a01e8756d1e4bdfd10e031d2de9e4
+  data.tar.gz: d10fa61a1f6e25b653f8c778e3a58cb6e06e5e2a1f839429100b7ebc1aecd77266d423faffd565446b5228ed3e9d775c55e1171f24e70d26f8ce3f7fe73bd4e6

data/bin/bakeqac

@@ -15,27 +15,53 @@ STDERR.sync = true
 
 module Bake
 
-def self.printCip()
-  cips = Dir.glob(@options.qacdata + "/**/*.cip")
-  if !cips.empty?
-    puts "Temporary debug output to find a highly sporadic bug regarding cip file, sorry for spam:"
-    puts "cip file name: #{cips[0]}"
-    puts "cip file size: #{File.size?(cips[0])}"
-  end
-end
+@@cipFileSize = 1
 
-def self.cipSize()
+def self.checkCipSize()
   cips = Dir.glob(@options.qacdata + "/**/*.cip")
   if !cips.empty?
     s = File.size?(cips[0])
-    if s.nil? || s == 0
-      puts "cip file empty: #{cips[0]}"
-      return 0
+    s = 0 if s.nil?
+    if s < @@cipFileSize
+      puts "cip file too small: #{cips[0]} has #{s} bytes"
+      return false
     end
-    return s
+    @@cipFileSize = s
+    return true
   end
   puts "cip file does not exist!"
-  return 0
+  return false
+end
+
+def self.executeQacli(cmd, immediateOutput = false)
+  timeStart = Time.now
+  cSizeCheck = true
+  licenseError = false
+  consoleOutput = ""
+  success = false
+
+  loop do
+    success, consoleOutput = ProcessHelper.run(cmd, immediateOutput)
+    licenseError = false
+
+    consoleOutput.each_line do |line|
+      if (line.include?("License Refused") && !line.include?("License Refused: C:"))
+        licenseError = true
+        puts "License refused!"
+        break
+      end
+    end
+
+    cSizeCheck = checkCipSize()
+
+    break unless ((@options.qacretry >= (Time.now - timeStart)) && (!cSizeCheck || licenseError))
+    puts "Retry seconds left: %d" % (@options.qacretry - (Time.now - timeStart))
+  end
+  checkError = !cSizeCheck || licenseError
+  puts "Retry timeout over -> failure." if @options.qacretry > 0 && checkError
+
+  success = false if checkError
+  return [success, consoleOutput, checkError]
 end
 
 ###### PREREQUISITE 1: BAKEQAC OPTIONS ######
@@ -43,11 +69,7 @@ end
   @options = BakeqacOptions.new(ARGV)
   bakeOptions = Options.new([])
   @options.parse_options(bakeOptions)
-
   success = false
-  consoleOutput = ""
-  licenseError = false
-  cSize = 1
 
 ###### PREREQUISITE 2: BAKE OPTIONS ######
 
@@ -92,26 +114,8 @@ end
 
     puts "bakeqac: creating database..."
 
-    cipCounter = 0
-    loop do
-      FileUtils.rm_rf @options.qacdata
-      success, consoleOutput = ProcessHelper.run(cmd, true)
-
-      break if not success
-
-      printCip()
-
-      cips = Dir.glob(@options.qacdata + "/**/*.cip")
-      break if (!cips.empty?) && (!File.size?(cips[0]).nil?) # this is the regular case, note: "size?" returns nil if empty or not existing
-
-      cipCounter += 1
-      if cipCounter < 10
-        puts "cip file does not exist or is empty, trying again..."
-      else
-        success = false
-        break
-      end
-    end
+    FileUtils.rm_rf @options.qacdata
+    success, consoleOutput, checkError = executeQacli(cmd, true)
 
     if success
       cctFilename = @options.qacdata+"/prqa/config/"+File.basename(@options.cct[0])
@@ -137,7 +141,6 @@ end
     else
       puts consoleOutput
     end
-
   end
 
 ###### STEP 2: BUILD ######
@@ -164,43 +167,26 @@ end
 
     puts "bakeqac: building and analyzing files..."
 
-    timeStart = Time.now
-    loop do
-      success, consoleOutput = ProcessHelper.run(cmd, false)
-      licenseError = false
+    success, consoleOutput, checkError = executeQacli(cmd)
+    success = false # we have to parse the output, qacli returns always an error here...
 
+    if !checkError
+      filterOutput = []
+      filter = []
+      endFound = false
       consoleOutput.each_line do |line|
-        if (line.include?("License Refused") && !line.include?("License Refused: C:"))
-          licenseError = true
-          puts "License refused!"
-          break
-        end
-      end
-
-      cSize = cipSize()
-
-      break unless ((@options.qacretry >= (Time.now - timeStart)) && (cSize == 0 || licenseError))
-      puts "Retry seconds left: %d" % (@options.qacretry - (Time.now - timeStart))
-    end
-    puts "Retry timeout over -> failure." if (@options.qacretry > 0 && (cSize == 0 || licenseError))
-
-    success = false # we have to parse the output, qacli returns always an error here...
-    filterOutput = []
-    filter = []
-    endFound = false
-    consoleOutput.each_line do |line|
-      scan_res = line.scan(/Project path: ([a-zA-Z]{0,1})(:{0,1})(.*)/)
-      if scan_res.length > 0
-        filter << (scan_res[0][0].downcase + scan_res[0][1] + scan_res[0][2].gsub(/\\/,"/").strip)
-      elsif !endFound
-        filterOutput << line
-        if line.start_with?("Rebuilding ")
-          endFound = true
-          success = true if line.include?("Rebuilding done") # don't know why the return value is 2 in this case...
+        scan_res = line.scan(/Project path: ([a-zA-Z]{0,1})(:{0,1})(.*)/)
+        if scan_res.length > 0
+          filter << (scan_res[0][0].downcase + scan_res[0][1] + scan_res[0][2].gsub(/\\/,"/").strip)
+        elsif !endFound
+          filterOutput << line
+          if line.start_with?("Rebuilding ")
+            endFound = true
+            success = true if line.include?("Rebuilding done") # don't know why the return value is 2 in this case...
+          end
         end
       end
     end
-    success = false if (cSize == 0 || licenseError)
 
     if @options.qacfilter
       if success
@@ -214,8 +200,6 @@ end
     else
       puts consoleOutput # no filter
     end
-
-    printCip()
   end
 
 
@@ -241,27 +225,7 @@ end
       cmd += ["-f", "%?u==0%(MSG: %:trc: %)%F(%l,%c): (%r:%N)%t%?v%(\n%v%)"]
     end
 
-    timeStart = Time.now
-    loop do
-      success, consoleOutput = ProcessHelper.run(cmd, false)
-      licenseError = false
-
-      consoleOutput.each_line do |line|
-        if (line.include?("License Refused") && !line.include?("License Refused: C:"))
-          licenseError = true
-          puts "License refused!"
-          break
-        end
-      end
-
-      cSize = cipSize()
-
-      break unless ((@options.qacretry >= (Time.now - timeStart)) && (cSize == 0 || licenseError))
-      puts "Retry seconds left: %d" % (@options.qacretry - (Time.now - timeStart))
-    end
-    puts "Retry timeout over -> failure." if (@options.qacretry > 0 && (cSize == 0 || licenseError))
-
-    success = false if (cSize == 0 || licenseError)
+    success, consoleOutput, checkError = executeQacli(cmd)
 
     if useFilter
       if success
@@ -342,9 +306,6 @@ end
     else
       puts consoleOutput # no filter
     end
-
-    printCip()
-
   end
 
 ###### STEP 4a: REPORT SCRIPT CHECK (OPTIONAL) ######

data/documentation/_build/html/_sources/changelog.txt

@@ -1,9 +1,13 @@
 Changelog
 =========
 
+January x, 2017 - bake-toolkit 2.27.0
+    * Added: local *Adapt* with conditions (e.g. toolchain), see :ref:`adapt_reference`.
+    * Changed: qac: cip workaround slightly adapted, removed temporary debug output.
+
 December 23, 2016 - bake-toolkit 2.26.1
-    * Changed: qac: next try to add a workaround for the cip file bug..
-    * Cosmetic: possible wrong message when reloading metas ("corrupt" instead of "changed")
+    * Changed: qac: next try to add a workaround for the cip file bug.
+    * Cosmetic: fixed possible wrong message when reloading metas ("corrupt" instead of "changed")
 
 December 20, 2016 - bake-toolkit 2.26.0
     * Changed: before this version, "-w" command line args (which define the workspace roots) have overwritten roots.bake file. Now these roots will be

data/documentation/_build/html/_sources/index.txt

@@ -1,4 +1,4 @@
-bake 2.26.1
+bake 2.27.0
 ==========================================
 bake, building software **fast** and **easy**!
 

data/documentation/_build/html/_sources/syntax/adapt_configs.txt

@@ -1,8 +1,20 @@
+.. _adapt_reference:
+
 Adapt configs
 =============
 
 Introduction
-************
+------------
+
+There are two major use cases:
+
+- Changing the configs from outside, e.g. injecting a toolchain.
+- Changing the configs depending on variables like the operating system.
+
+Both is possible with the *Adapt* feature.
+
+From command line
+-----------------
 
 If you want to manipulate existing configs without changing them, you can "adapt" them via command line.
 
@@ -10,7 +22,7 @@ If you want to manipulate existing configs without changing them, you can "adapt
 
     User@Host:~$ bake test --adapt abc
 
-bake searches for abc/Adapt.meta within the workspace roots. If found, the configs from the adapt file are parsed:
+bake searches for abc/Adapt.meta within the workspace roots. If found, the configs from the Adapt.meta are parsed:
 
 .. code-block:: text
 
@@ -20,7 +32,7 @@ bake searches for abc/Adapt.meta within the workspace roots. If found, the confi
       CustomConfig ... # 0..n
     }
 
-Here is an example to change the DefaultToolchain
+Here is an example to change the DefaultToolchain (details explained below):
 
 .. code-block:: text
 
@@ -30,12 +42,71 @@ Here is an example to change the DefaultToolchain
       }
     }
 
+From Project.meta
+-----------------
+
+You can do the same within the Project.meta:
+
+.. code-block:: text
+
+    Project {
+      ...
+    }
+    Adapt {
+      ...
+    }
+    Adapt {
+      ...
+    }
+
+Conditions and effectiveness
+----------------------------
+
+Be aware, these are two different things but look very similar.
+
+Condition
+~~~~~~~~~
+
+An *Adapt* can have up to four attributes:
+
+- **toolchain**: e.g. GCC
+- **os**: can be Windows, Mac, Linux, Unix (which is != Linux)
+- **mainConfig**: name of the main config
+- **mainProject**: name of the main project
+
+The "Adapt* configs will be only applied if all these attributes are either empty or true. Example:
+
+.. code-block:: text
+
+    Adapt toolchain: GCC, os: Windows {
+      ...
+    }
+
+Here the *Adapt* configs will be applied if toolchain is GCC on Windows.
+
 Effectiveness
-*************
+~~~~~~~~~~~~~
 
-The adapt configs can be applied to all configs from regular build. This can be controlled by the config names and the project attributes. The example above
-is adapted only to the config "test" of the main project. __MAIN__ and __ALL__ are keywords. __MAIN__ means the main project or config, __ALL__ means all
-projects or configs. If you want to apply the changes only to the top level config, write:
+The *Adapt* configs can be applied to all configs from regular build. This can be controlled by the config names and the project attributes.
+Remember the example from the beginning?
+
+.. code-block:: text
+
+    Adapt {
+      ExecutableConfig test, project: __MAIN__, type: replace {
+        DefaultToolchain GCC
+      }
+    }
+
+This config is applied only to the config "test" of the main project.
+
+__MAIN__, __ALL__ and __THIS__ are keywords:
+
+- **__MAIN__** means the main project or main config
+- **__ALL__** means all projects or configs
+- **__THIS__** is only valid for project name, which can be used for *Adapts* within a Project.meta to restrict the adaption to the current project.
+
+If you want to apply the changes only to the top level config, write:
 
 .. code-block:: text
 
@@ -50,9 +121,9 @@ If you want to apply the changes to all configs, write:
 It is possible to mix the keywords with reals project or config names.
 
 Occurrences
-***********
+-----------
 
-You can specify more configs in one adapt file and you can specify more than one adapt file:
+You can specify more configs in one *Adapt* and you can specify more than one Adapt.meta file:
 
 .. code-block:: text
 
@@ -73,10 +144,25 @@ You can specify more configs in one adapt file and you can specify more than one
 
     User@Host:~$ bake test --adapt abc --adapt xy
 
-They will be applied in the specified order.
+Apply order
+-----------
+
+The *Adapt* configs will be applied in the order in which they were parsed. First the Adapt.metas referenced from the command line are read. Then the Project.metas are read
+one by one as usual. If an *Adapt* is found, it will be appended to the list of *Adapts*. Note, *Adapts* will be applied immediately when a Project.meta is read.
+
+If you inject a Toolchain from outside, e.g. "--adapt gcc", you can use the toolchain info for local *Adapts*:
+
+.. code-block:: text
+
+    Project {
+      ...
+    }
+    Adapt toolchain: GCC {
+      ...
+    }
 
 Types
-*****
+-----
 
 It is possible to specify the type of adaption:
 
@@ -84,15 +170,19 @@ It is possible to specify the type of adaption:
 
       ExecutableConfig ..., type: replace
 
-The type can be "replace", "remove" or "extend".
+The type can be
+
+- **replace**
+- **remove**
+- **extend**
 
 Type: extend
-------------
+~~~~~~~~~~~~
 
 This works exactly like for :doc:`derive_configs`.
 
 Type: remove
-------------
+~~~~~~~~~~~~
 
 If parent elements can be found which matches to the child elements, they will be removed.
 
@@ -104,7 +194,7 @@ Example project config:
       DefaultToolchain GCC
     }
 
-Example adapt configs:
+Example *Adapt* configs:
 
 .. code-block:: text
 
@@ -125,7 +215,7 @@ Example adapt configs:
     }
 
 Type: replace
--------------
+~~~~~~~~~~~~~
 
 This is for convenience. "replace" will remove all elements with the same type and extends the configs.
 
@@ -140,4 +230,4 @@ Example:
       }
     }
 
-This removes all "Files" and the "DefaultToolchain" from the original config regardless their attributes and replaces them by the elements of the adapt config.
+This removes all "Files" and the "DefaultToolchain" from the original config regardless their attributes and replaces them by the elements of the *Adapt* config.