Merge pull request #162 from martinbudden/tests_py

Improved resilience of compare_images.

libtest.scad

@@ -33,6 +33,8 @@
 //!
 //! See [usage](docs/usage.md) for requirements, installation instructions and a usage guide.
 //!
+//! A list of changes classified as breaking, additions or fixes is maintained in [CHANGELOG.md](CHANGELOG.md).
+//!
 //! <img src="libtest.png" width="100%"/>
 //
 // This file shows all the parts in the library.
@@ -205,8 +207,8 @@ ball_bearings_y = pillars_y + 40;
 pulleys_y = ball_bearings_y +40;
 hot_ends_y = pulleys_y + 60;
 linear_bearings_y = hot_ends_y + 50;
-sheets_y = linear_bearings_y + 100;
-pcbs_y = sheets_y + 40;
+sheets_y = linear_bearings_y + 90;
+pcbs_y = sheets_y + 60;
 displays_y = pcbs_y + 170;
 fans_y = displays_y + 80;
 transformers_y = fans_y + 120;

readme.md

@@ -14,6 +14,8 @@ The license is GNU General Public License v3.0, see [COPYING](COPYING).
 
 See [usage](docs/usage.md) for requirements, installation instructions and a usage guide.
 
+A list of changes classified as breaking, additions or fixes is maintained in [CHANGELOG.md](CHANGELOG.md).
+
 <img src="libtest.png" width="100%"/>
 
 ## Table of Contents<a name="top"/>
@@ -3154,6 +3156,7 @@ When woven sheets (e.g. carbon fibre) are rendered it is necessary to specify th
 |   1 | `sheet(FoilTape, 30, 30, 2)` |  Aluminium foil tape 30mm x 30mm x 0.05mm |
 |   1 | `sheet(AL6, 30, 30, 2)` |  Aluminium tooling plate 30mm x 30mm x 6mm |
 |   1 | `sheet(AL8, 30, 30, 2)` |  Aluminium tooling plate 30mm x 30mm x 8mm |
+|   1 | `sheet(Spring05, 30, 30, 2)` |  Bi-metal saw blade 30mm x 30mm x 0.5mm |
 |   1 | `sheet(Cardboard, 30, 30, 2)` |  Corrugated cardboard 30mm x 30mm x 5mm |
 |   1 | `sheet(Foam20, 30, 30, 2)` |  Foam sponge 30mm x 30mm x 20mm |
 |   1 | `sheet(DiBond, 30, 30, 2)` |  Sheet DiBond 30mm x 30mm x 3mm |
@@ -3172,6 +3175,7 @@ When woven sheets (e.g. carbon fibre) are rendered it is necessary to specify th
 |   1 | `sheet(CF3, 30, 30, 2)` |  Sheet carbon fiber 30mm x 30mm x 3mm |
 |   1 | `sheet(glass2, 30, 30, 2)` |  Sheet glass 30mm x 30mm x 2mm |
 |   1 | `sheet(Steel06, 30, 30, 2)` |  Sheet mild steel 30mm x 30mm x 0.6mm |
+|   1 | `sheet(Silicone3, 30, 30, 2)` |  Sheet silicone 30mm x 30mm x 3mm |
 
 
 <a href="#top">Top</a>

scripts/changelog.py

@@ -0,0 +1,163 @@
+#!/usr/bin/env python
+
+#
+# NopSCADlib Copyright Chris Palmer 2021
+# nop.head@gmail.com
+# hydraraptor.blogspot.com
+#
+# This file is part of NopSCADlib.
+#
+# NopSCADlib is free software: you can redistribute it and/or modify it under the terms of the
+# GNU General Public License as published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# NopSCADlib is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with NopSCADlib.
+# If not, see <https://www.gnu.org/licenses/>.
+#
+#! Creates the changelog from the git log
+
+from __future__ import print_function
+import sys
+import subprocess
+import re
+
+filename = 'CHANGELOG.md'
+
+def tag_version(t):
+    """ Format a version tag """
+    return 'v%d.%d.%d' % t
+
+def initials(name):
+    """ Convert full name to initials with a tooltip """
+    i = ''.join([n[0].upper() + '.' for n in name.split(' ')])
+    return '[%s](# "%s")' % (i, name)
+
+def get_remote_url():
+    """ Get the git remote URL for the repository """
+    url = subprocess.check_output(["git", "config", "--get", "remote.origin.url"]).decode("utf-8").strip("\n")
+    if url.startswith("git@"):
+        url = url.replace(":", "/", 1).replace("git@", "https://", 1)
+    if url.endswith(".git"):
+        url = url[:-4]
+    return url
+
+def iscode(word):
+    """ try to guess if the word is code """
+    endings = ['()', '*']
+    starts = ['$', '--']
+    anywhere = ['.', '_', '=', '[', '/']
+    words = ['center', 'false', 'true', 'ngb']
+
+    for w in words:
+        if word == w:
+            return True
+
+    for end in endings:
+        if word.endswith(end):
+            return True
+
+    for start in starts:
+        if word.startswith(start):
+            return True
+
+    for any in anywhere:
+        if word.find(any) >= 0:
+            return True
+
+    return False
+
+def codify(word, url):
+    """ if a word is deemed code enclose it backticks """
+    if word:
+        if re.match(r'#[0-9]+', word):
+            return '[%s](%s "show issue")' % (word, url + '/issues/' + word[1:])
+        if iscode(word):
+            return  '`' + word + '`'
+    return word
+
+
+def fixup_comment(comment, url):
+    """ markup code words and fix new paragraphs """
+    result = ''
+    word = ''
+    code = False
+    for i, c in enumerate(comment):
+        if c == '`' or code:                # Already a code block
+            result += c                     # Copy verbatim
+            if c == '`': code = not code    # Keep track of state
+        else:
+            if c in ' \n' or (c == '.' and (i + 1 == len(comment) or comment[i + 1] in ' \n')): # if a word terminator
+                result += codify(word, url) + c  # Add codified word before terminator
+                word = ''
+            else:
+                word += c                   # Accumulate next word
+    result += codify(word, url)             # In case comment ends without a terminator
+    return result.replace('\n\n','\n\n * ') # Give new paragraphs a bullet point
+
+class Commit(): # members dynamically added from commit_fields
+    pass
+
+blurb = """
+# %s Changelog
+This changelog is generated by `changelog.py` using manually added semantic version tags to classify commits as breaking changes, additions or fixes.
+
+"""
+
+if __name__ == '__main__':
+    url = get_remote_url()
+
+    commit_fields = {
+        'hash':    "%H|",       # commit commit_hash
+        'tag':     "%D|",       # tag
+        'author': "%aN|",       # author name
+        'date': "  %as|",       # author date short form
+        'comment': "%B~"        # body
+    }
+
+    # Produce the git log
+    format = ''.join([v for k, v in commit_fields.items()])
+    text = subprocess.check_output(["git", "log", "--topo-order", "--format=" + format]).decode("utf-8")
+
+    # Process the log into a list of Commit objects
+    commits = []
+    for line in text.split('~'):
+        line = line.strip('\n')
+        if line:
+            fields = line.split('|')
+            commit = Commit()
+            for i, k in enumerate(commit_fields):
+                exec('commit.%s = """%s"""' % (k, fields[i]), locals())
+            # Convert version tag to tuple
+            if commit.tag:
+                match = re.match(r'.*tag: v([0-9]+)\.([0-9]+)\.([0-9]+).*', commit.tag)
+                commit.tag = (int(match.group(1)), int(match.group(2)), int(match.group(3))) if match else ''
+            commits.append(commit)
+
+    # Format the results from the Commit objects
+    with open(filename, "wt") as file:
+        print(blurb % url.split('/')[-1], file = file)
+        for i, c in enumerate(commits):
+            if c.tag:
+                ver = tag_version(c.tag)
+                level, type = (3, 'Fixes') if c.tag[2] else (2, 'Additions') if c.tag[1] else (1, 'Breaking Changes') if c.tag[0] else (1, 'First publicised version')
+
+                # Find the previous tagged commit
+                j = i + 1
+                diff = ''
+                while j < len(commits):
+                    if commits[j].tag:
+                        last_ver = tag_version(commits[j].tag)
+                        diff = '[...](%s "diff with %s")' % (url + '/compare/' + last_ver + '...' + ver, last_ver)
+                        break
+                    j += 1
+
+                # Print verson info
+                print('%s [%s](%s "show release") %s %s' % ('#' * (level + 1), ver, url + '/releases/tag/' + ver, type, diff), file = file)
+
+            # Print commits excluding merges
+            if not c.comment.startswith('Merge branch') and not c.comment.startswith('Merge pull'):
+                print('* %s [`%s`](%s "show commit") %s %s\n' % (c.date, c.hash[:7], url + '/commit/' + c.hash, initials(c.author), fixup_comment(c.comment, url)), file = file)

scripts/exports.py

@@ -142,7 +142,7 @@ def make_parts(target, part_type, parts = None):
                                                 f.write("use <%s/%s>\n" % (reltmp(dir, target), filename))
                                                 f.write("%s();\n" % module);
                                             t = time.time()
-                                            openscad.run("-D$bom=1", "-d", dname, "-o", part_file, part_maker_name)
+                                            openscad.run("-o", part_file, part_maker_name, "-D$bom=1", "-d", dname)
                                             times.add_time(part, t)
                                             if part_type == 'stl':
                                                 bounds = c14n_stl.canonicalise(part_file)

scripts/openscad.py

@@ -25,7 +25,7 @@ from __future__ import print_function
 import subprocess, sys
 
 def run_list(args, silent = False, verbose = False):
-    cmd = ["openscad", "--hardwarnings"] + args
+    cmd = ["openscad"] + args + ["--hardwarnings"]
     if not silent:
         for arg in cmd:
             print(arg, end=" ")

scripts/readme.md

@@ -8,6 +8,7 @@ They should work with both Python 2 and Python 3.
 |:---|:---|
 | `bom.py` | Generates BOM files for the project. |
 | `c14n_stl.py` | OpenSCAD produces randomly ordered STL files. This script re-orders them consistently so that GIT can tell if they have changed or not. |
+| `changelog.py` | Creates the changelog from the git log |
 | `doc_scripts.py` | Makes this document and doc/usage.md. |
 | `dxfs.py` | Generates DXF files for all the routed parts listed on the BOM or a specified list. |
 | `gallery.py` | Finds projects and adds them to the gallery. |

scripts/render.py

@@ -94,7 +94,7 @@ def render(target, type):
             cam = "--camera=0,0,0,70,0,315,500" if type == 'stl' else "--camera=0,0,0,0,0,0,500"
             render = "--preview" if type == 'stl' or colour != pp1 else "--render"
             tmp_name = tmp_dir + '/' + part[:-4] + '.png'
-            openscad.run(colour_scheme, "--projection=p", "--imgsize=4096,4096", cam, render, "--autocenter", "--viewall", "-o", tmp_name, png_maker_name);
+            openscad.run("-o", tmp_name, png_maker_name, colour_scheme, "--projection=p", "--imgsize=4096,4096", cam, render, "--autocenter", "--viewall");
             do_cmd(("magick "+ tmp_name + " -trim -resize 280x280 -background %s -gravity Center -extent 280x280 -bordercolor %s -border 10 %s"
                     % (background, background, tmp_name)).split())
             update_image(tmp_name, png_name)

scripts/tests.py

@@ -60,7 +60,8 @@ def compare_images(a, b, c):
     with open(log_name, 'w') as output:
         do_cmd(("magick compare -metric AE -fuzz %d%% %s %s %s" % (fuzz, a, b, c)).split(), output = output)
     with open(log_name, 'r') as f:
-        pixels = int(float(f.read().strip()))
+        pixels = f.read().strip()
+        pixels = int(float(pixels if pixels.isnumeric() else -1))
     os.remove(log_name)
     return pixels
 
@@ -116,7 +117,7 @@ def tests(tests):
         libtest = True
         lib_blurb = scrape_blurb(scad_name)
         if not os.path.isfile(png_name):
-            openscad.run(colour_scheme, "--projection=p", "--imgsize=%d,%d" % (w, h), "--camera=0,0,0,50,0,340,500", "--autocenter", "--viewall", "-o", png_name, scad_name);
+            openscad.run(scad_name, "-o", png_name, colour_scheme, "--projection=p", "--imgsize=%d,%d" % (w, h), "--camera=0,0,0,50,0,340,500", "--autocenter", "--viewall");
             do_cmd(["magick", png_name, "-trim", "-resize", "1280", "-bordercolor", background, "-border", "10", png_name])
     else:
         #
@@ -237,7 +238,7 @@ def tests(tests):
                 print(changed)
                 t = time.time()
                 tmp_name = tmp_dir + '/tmp.png'
-                openscad.run_list(options.list() + ["-D$bom=2", colour_scheme, "--projection=p", "--imgsize=%d,%d" % (w, h), "--camera=0,0,0,70,0,315,500", "--autocenter", "--viewall", "-d", dname, "-o", tmp_name, scad_name]);
+                openscad.run_list([scad_name, "-o", tmp_name] + options.list() + ["-D$bom=2", colour_scheme, "--projection=p", "--imgsize=%d,%d" % (w, h), "--camera=0,0,0,70,0,315,500", "--autocenter", "--viewall", "-d", dname]);
                 times.add_time(scad_name, t)
                 do_cmd(["magick", tmp_name, "-trim", "-resize", "1000x600", "-bordercolor", background, "-border", "10", tmp_name])
                 update_image(tmp_name, png_name)

scripts/views.py

@@ -221,7 +221,7 @@ def views(target, do_assemblies = None):
                                                 target_def = ['-D$target="%s"' % target] if target else []
                                                 cwd_def = ['-D$cwd="%s"' % os.getcwd().replace('\\', '/')]
                                                 view_def = ['--viewall', '--autocenter'] if not (zoomed & (1 << explode)) else ['--camera=0,0,0,55,0,25,140']
-                                                openscad.run_list(options.list() + target_def + cwd_def + view_def +["-D$pose=1", "-D$explode=%d" % explode, colour_scheme, "--projection=p", "--imgsize=4096,4096", "-d", dname, "-o", tmp_name, png_maker_name]);
+                                                openscad.run_list(["-o", tmp_name, png_maker_name] + options.list() + target_def + cwd_def + view_def + ["-D$pose=1", "-D$explode=%d" % explode, colour_scheme, "--projection=p", "--imgsize=4096,4096", "-d", dname]);
                                                 times.add_time(png_name, t)
                                                 do_cmd(["magick", tmp_name, "-trim", "-resize", "1004x1004", "-bordercolor", background, "-border", "10", tmp_name])
                                                 update_image(tmp_name, png_name)

tests/PCBs.scad

@@ -29,7 +29,7 @@ module pcbs() {
             rotate(90)
                 pcb_assembly(pcbs[$i], 5 + $i, 3);
 
-    translate([0, 120])
+    translate([0, 110])
         layout([for(p = perfboards) pcb_length(p)], 10)
             translate([0, -pcb_width(perfboards[$i]) / 2])
                 pcb_assembly(perfboards[$i], 5 + $i, 3);

tests/sheets.scad

@@ -25,25 +25,30 @@ include <../vitamins/screws.scad>
 width = 30;
 2d = true;
 
-module sheets()
-    layout([for(s = sheets) width], 5)
-        let(sheet = sheets[$i], w = sheet_is_woven(sheet) ? width : undef)
-        if(2d)
-            render_2D_sheet(sheet, w = w, d = w)
-                difference() {
-                    sheet_2D(sheet, width, width, 2);
+module sheets() {
+    rows = 2;
+    n = ceil(len(sheets) / rows);
+    w = width + 5;
+    for(y = [0 : rows - 1], x = [0 : n - 1], s = y * n + x)
+        if(s < len(sheets))
+            translate([width / 2 + x * w, y * w])
+                let(sheet = sheets[s], w = sheet_is_woven(sheet) ? width : undef)
+                if(2d)
+                    render_2D_sheet(sheet, w = w, d = w)
+                        difference() {
+                            sheet_2D(sheet, width, width, 2);
 
-                    circle(3);
-                }
-        else
-            render_sheet(sheet, w = w, d = w)
-                difference() {
-                    sheet(sheet, width, width, 2);
-
-                    translate_z(sheet_thickness(sheet) / 2)
-                        screw_countersink(M3_cs_cap_screw);
-                }
+                            circle(3);
+                        }
+                else
+                    render_sheet(sheet, w = w, d = w)
+                        difference() {
+                            sheet(sheet, width, width, 2);
 
+                            translate_z(sheet_thickness(sheet) / 2)
+                                screw_countersink(M3_cs_cap_screw);
+                        }
+}
 
 if($preview)
     sheets();

vitamins/sheets.scad

@@ -45,11 +45,14 @@ Foam20    = [ "Foam20",    "Foam sponge",             20,[0.3, 0.3, 0.3, 1    ],
 AL6       = [ "AL6",       "Aluminium tooling plate", 6, [0.9, 0.9, 0.9, 1    ], false];
 AL8       = [ "AL8",       "Aluminium tooling plate", 8, [0.9, 0.9, 0.9, 1    ], false];
 Steel06   = [ "Steel06",   "Sheet mild steel",       0.6,"silver"              , false];
-CF1 =       [ "CF1",       "Sheet carbon fiber",      1, grey(30),               false,  2,  2,  grey(25)];
-CF2 =       [ "CF2",       "Sheet carbon fiber",      2, grey(30),               false,  2,  2,  grey(25)];
-CF3 =       [ "CF3",       "Sheet carbon fiber",      3, grey(30),               false,  2,  2,  grey(25)];
+Spring05  = [ "Spring05",  "Bi-metal saw blade",     0.5,"#FBC300",              false];
+Silicone3 = [ "Silicone3", "Sheet silicone",          3, [0.9, 0.9, 0.9, 0.95 ], false];
+CF1 =       [ "CF1",       "Sheet carbon fiber",      1, grey(35),               false,  2,  2,  grey(20)];
+CF2 =       [ "CF2",       "Sheet carbon fiber",      2, grey(35),               false,  2,  2,  grey(20)];
+CF3 =       [ "CF3",       "Sheet carbon fiber",      3, grey(35),               false,  2,  2,  grey(20)];
 
 
-sheets = [CF1, CF2, CF3, MDF6, MDF10, MDF12, MDF19, PMMA2, PMMA3, PMMA6, PMMA8, PMMA10, glass2, DiBond, DiBond6, Cardboard, FoilTape, Foam20, AL6, AL8, Steel06];
+sheets = [CF1, CF2, CF3, MDF6, MDF10, MDF12, MDF19, PMMA2, PMMA3, PMMA6, PMMA8, PMMA10,
+         glass2, DiBond, DiBond6, Cardboard, FoilTape, AL6, AL8, Steel06, Spring05, Silicone3, Foam20];
 
 use <sheet.scad>