Merge pull request #352 from zapta/develop

Added an apio test command.

apio/commands/test.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+# -- This file is part of the Apio project
+# -- (C) 2016-2019 FPGAwars
+# -- Author Jesús Arroyo
+# -- Licence GPLv2
+"""TODO"""
+
+import click
+from apio.managers.scons import SCons
+
+
+@click.command("test")
+@click.pass_context
+@click.option(
+    "-p",
+    "--project-dir",
+    type=str,
+    metavar="path",
+    help="Set the target directory for the project.",
+)
+@click.option(
+    "-t",
+    "--testbench",
+    type=str,
+    metavar="testbench",
+    help="Test only this testbench file.",
+)
+def cli(ctx, project_dir, testbench):
+    """Launch the verilog testbench testing."""
+
+    exit_code = SCons(project_dir).test({"testbench": testbench})
+    ctx.exit(exit_code)

apio/managers/scons.py

@@ -103,7 +103,7 @@ def lint(self, args):
 
     @util.command
     def sim(self, args):
-        """DOC: TODO"""
+        """Simulates a testbench and shows the result in a gtkwave window."""
 
         # -- Split the arguments
         var, _, arch = process_arguments(args, self.resources)
@@ -114,6 +114,20 @@ def sim(self, args):
             arch=arch,
             packages=["oss-cad-suite", "gtkwave"],
         )
+
+    @util.command
+    def test(self, args):
+        """Tests all or a single testbench by simulating."""
+
+        # -- Split the arguments
+        var, _, arch = process_arguments(args, self.resources)
+
+        return self.run(
+            "test",
+            variables=var,
+            arch=arch,
+            packages=["oss-cad-suite"],
+        )
 
     @util.command
     def build(self, args):

apio/resources/ecp5/SConstruct

@@ -115,32 +115,6 @@ if len(src_synth) == 0:
     print('Error: no verilog module files found (.v)')
     Exit(1)
 
-# If running the sim command, determine the testbench to simulate.
-SIMULNAME = ''
-if 'sim' in COMMAND_LINE_TARGETS: 
-    if TESTBENCH:
-        testbench = TESTBENCH   # Explicit from the --testbench flag.
-    else:
-        if len(list_tb) == 0:
-            print('Error: no testbench found for simulation.')
-            Exit(1)
-        if len(list_tb) > 1:
-            # TODO: consider to allow specifying the default testbench in apio.ini.
-            print('Error: found {} testbranches, please use the --testbench flag.'.format(len(list_tb)))
-            for tb in list_tb:
-                print('- {}'.format(tb))
-            Exit(1)
-        testbench = list_tb[0]  # Pick the only available testbench.
-    # List of simulation files which Includes the testbench and all the module files.
-    src_sim = []
-    src_sim.extend(src_synth)  # All the .v files.
-    src_sim.append(testbench)
-    SIMULNAME, _ = os.path.splitext(testbench)
-
-# -- For debugging
-# print('Testbench: {}'.format(testbench))
-# print('SIM NAME: {}'.format(SIMULNAME))
-
 # -- Get the LPF file
 LPF = ''
 LPF_list = Glob('*.lpf')
@@ -203,9 +177,32 @@ AlwaysBuild(rpt)
 t = env.Alias('time', rpt)
 
 # -- Icarus Verilog builders
+
+def iverilog_generator(source, target, env, for_signature):
+    """Constructs dynamically a commands for iverlog targets builders. """
+    target_name, _  = os.path.splitext(str(target[0]))  # E.g. "my_module" or"my_module_tb"
+    is_testbench = target_name.upper().endswith("_TB")
+    # If running a testbench with the sim command, we pass to the benchmark a macro that
+    # will allow it to supress assertions so we can examine the waves. For example, with 
+    # an assertion macro like this one that fails when running apio test.
+    #
+    # `define EXPECT(signal, value) \
+    #     if (signal !== value) begin \
+    #         $display("ASSERTION FAILED in %m: signal != value"); \
+    #         `ifndef INTERACTIVE_SIM \
+    #             $fatal; \
+    #         `endif \
+    #     end
+    is_interactive = is_testbench and 'sim' in COMMAND_LINE_TARGETS
+    vcd_output_flag = f'-D VCD_OUTPUT={target_name}' if is_testbench else ""
+    interactive_flag = f'-D INTERACTIVE_SIM' if is_interactive else ""
+    result = 'iverilog {0} -o $TARGET {1} {2} -D NO_INCLUDES "{3}/ecp5/cells_sim.v" $SOURCES'.format(
+        IVER_PATH, vcd_output_flag, interactive_flag, YOSYS_PATH)
+    return result
+
 iverilog = Builder(
-    action='iverilog {0} -o $TARGET -D VCD_OUTPUT={1} -D NO_INCLUDES "{2}/ecp5/cells_sim.v" $SOURCES'.format(
-        IVER_PATH, SIMULNAME, YOSYS_PATH),
+    # Action string is computed automatically by the generator.
+    generator = iverilog_generator,
     suffix='.out',
     src_suffix='.v',
     source_scanner=list_scanner)
@@ -229,14 +226,73 @@ AlwaysBuild(verify)
 # Since the simulation targets are dynamic due to the testbench selection, we 
 # create them only when running simulation.
 if 'sim' in COMMAND_LINE_TARGETS: 
-    sout = env.IVerilog(SIMULNAME, src_sim)
+    assert 'test' not in COMMAND_LINE_TARGETS, COMMAND_LINE_TARGETS
+    if TESTBENCH:
+        # Explicit testbench file name is given via --testbench.
+        sim_testbench = TESTBENCH
+    else:
+        # No --testbench flag was specified. If there is exactly one testbench then pick
+        # it, otherwise fail. 
+        if len(list_tb) == 0:
+            print('Error: no testbench found for simulation.')
+            Exit(1)
+        if len(list_tb) > 1:
+            # TODO: consider to allow specifying the default testbench in apio.ini.
+            print('Error: found {} testbranches, please use the --testbench flag.'.format(len(list_tb)))
+            for tb in list_tb:
+                print('- {}'.format(tb))
+            Exit(1)
+        sim_testbench = list_tb[0]  # Pick the only available testbench.
+    # Here sim_testbench contains the testbench, e.g. my_module_tb.v.
+    # Construct list of files to build.
+    src_sim = []
+    src_sim.extend(src_synth)  # All the .v files.
+    src_sim.append(sim_testbench)
+    # Create targets sim target and its dependent.
+    sim_name, _ = os.path.splitext(sim_testbench)  #e.g. my_module_tb
+    sout = env.IVerilog(sim_name, src_sim)
     vcd_file = env.VCD(sout)
     # 'do_initial_zoom_fit' does max zoom only if .gtkw file not found.
     waves = env.Alias('sim', vcd_file, 'gtkwave {0} {1} {2}.gtkw'.format(
         '--rcvar "splash_disable on" --rcvar "do_initial_zoom_fit 1"',
-        vcd_file[0], SIMULNAME))
+        vcd_file[0], sim_name))
     AlwaysBuild(waves)
 
+
+# --- Testing
+# Since the simulation targets are dynamic due to the testbench selection, we 
+# create them only when running simulation.
+if 'test' in COMMAND_LINE_TARGETS: 
+    assert 'sim' not in COMMAND_LINE_TARGETS, COMMAND_LINE_TARGETS
+    if TESTBENCH:
+        # Explicit testbench file name is given via --testbench. We test just that one.
+        test_tbs= [ TESTBENCH ]
+    else:
+        # No --testbench flag specified. We will test all them.
+        if len(list_tb) == 0:
+            print('Error: no testbenchs found for simulation.')
+            Exit(1)
+        test_tbs= list_tb  # All testbenches.
+    tests = [] # Targets of all tests
+    for test_tb in test_tbs:
+        # Create a list of source files. All the modules + the current testbench.
+        src_test = []
+        src_test.extend(src_synth)  # All the .v files.
+        src_test.append(test_tb)
+        # Create the targets for the 'out' and 'vcd' files of the testbench.
+        # NOTE: Remove the two AlwaysBuild() calls below for an incremental test. Fast, correct,
+        # but may confuse the user seeing nothing happens. 
+        test_name, _ = os.path.splitext(test_tb)  #e.g. my_module_tb
+        test_out_target = env.IVerilog(test_name, src_test)
+        AlwaysBuild(test_out_target)
+        test_vcd_target = env.VCD(test_out_target)
+        AlwaysBuild(test_vcd_target)
+        test_target = env.Alias(test_name, [test_out_target, test_vcd_target])
+        tests.append(test_target)
+    # Create a target for the test command that depends on all the test targets.
+    tests_target = env.Alias('test', tests)
+    AlwaysBuild(tests_target)
+
 # -- Verilator builder
 verilator = Builder(
     action='verilator --lint-only -v {0}/ecp5/cells_sim.v {1} {2} {3} {4} $SOURCES'.format(

apio/resources/ice40/SConstruct

@@ -113,32 +113,6 @@ if len(src_synth) == 0:
     print('Error: no verilog module files found (.v)')
     Exit(1)
 
-# If running the sim command, determine the testbench to simulate.
-SIMULNAME = ''
-if 'sim' in COMMAND_LINE_TARGETS: 
-    if TESTBENCH:
-        testbench = TESTBENCH   # Explicit from the --testbench flag.
-    else:
-        if len(list_tb) == 0:
-            print('Error: no testbench found for simulation.')
-            Exit(1)
-        if len(list_tb) > 1:
-            # TODO: consider to allow specifying the default testbench in apio.ini.
-            print('Error: found {} testbranches, please use the --testbench flag.'.format(len(list_tb)))
-            for tb in list_tb:
-                print('- {}'.format(tb))
-            Exit(1)
-        testbench = list_tb[0]  # Pick the only available testbench.
-    # List of simulation files. Includes the testbench and all the .v files.
-    src_sim = []
-    src_sim.extend(src_synth)  # All the .v files.
-    src_sim.append(testbench)
-    SIMULNAME, _ = os.path.splitext(testbench)
-
-# -- For debugging
-# print('Testbench: {}'.format(testbench))
-# print('SIM NAME: {}'.format(SIMULNAME))
-
 # -- Get the PCF file
 PCF = ''
 PCF_list = Glob('*.pcf')
@@ -208,9 +182,32 @@ AlwaysBuild(rpt)
 t = env.Alias('time', rpt)
 
 # -- Icarus Verilog builders
+
+def iverilog_generator(source, target, env, for_signature):
+    """Constructs dynamically a commands for iverlog targets builders. """
+    target_name, _  = os.path.splitext(str(target[0]))  # E.g. "my_module" or"my_module_tb"
+    is_testbench = target_name.upper().endswith("_TB")
+    # If running a testbench with the sim command, we pass to the benchmark a macro that
+    # will allow it to supress assertions so we can examine the waves. For example, with 
+    # an assertion macro like this one that fails when running apio test.
+    #
+    # `define EXPECT(signal, value) \
+    #     if (signal !== value) begin \
+    #         $display("ASSERTION FAILED in %m: signal != value"); \
+    #         `ifndef INTERACTIVE_SIM \
+    #             $fatal; \
+    #         `endif \
+    #     end
+    is_interactive = is_testbench and 'sim' in COMMAND_LINE_TARGETS
+    vcd_output_flag = f'-D VCD_OUTPUT={target_name}' if is_testbench else ""
+    interactive_flag = f'-D INTERACTIVE_SIM' if is_interactive else ""
+    result = 'iverilog {0} -o $TARGET {1} {2} -D NO_ICE40_DEFAULT_ASSIGNMENTS "{3}/ice40/cells_sim.v" $SOURCES'.format(
+        IVER_PATH, vcd_output_flag, interactive_flag, YOSYS_PATH)
+    return result
+
 iverilog = Builder(
-    action='iverilog {0} -o $TARGET -D VCD_OUTPUT={1} -D NO_ICE40_DEFAULT_ASSIGNMENTS "{2}/ice40/cells_sim.v" $SOURCES'.format(
-        IVER_PATH, SIMULNAME, YOSYS_PATH),
+    # Action string is computed automatically by the generator.
+    generator = iverilog_generator,
     suffix='.out',
     src_suffix='.v',
     source_scanner=list_scanner)
@@ -234,14 +231,73 @@ AlwaysBuild(verify)
 # Since the simulation targets are dynamic due to the testbench selection, we 
 # create them only when running simulation.
 if 'sim' in COMMAND_LINE_TARGETS: 
-    sout = env.IVerilog(SIMULNAME, src_sim)
+    assert 'test' not in COMMAND_LINE_TARGETS, COMMAND_LINE_TARGETS
+    if TESTBENCH:
+        # Explicit testbench file name is given via --testbench.
+        sim_testbench = TESTBENCH
+    else:
+        # No --testbench flag specified. If there is exactly one testbench then pick
+        # it, otherwise fail. 
+        if len(list_tb) == 0:
+            print('Error: no testbench found for simulation.')
+            Exit(1)
+        if len(list_tb) > 1:
+            # TODO: consider to allow specifying the default testbench in apio.ini.
+            print('Error: found {} testbranches, please use the --testbench flag.'.format(len(list_tb)))
+            for tb in list_tb:
+                print('- {}'.format(tb))
+            Exit(1)
+        sim_testbench = list_tb[0]  # Pick the only available testbench.
+    # Here sim_testbench contains the testbench, e.g. my_module_tb.v.
+    # Construct list of files to build.
+    src_sim = []
+    src_sim.extend(src_synth)  # All the .v files.
+    src_sim.append(sim_testbench)
+    # Create targets sim target and its dependent.
+    sim_name, _ = os.path.splitext(sim_testbench)  #e.g. my_module_tb
+    sout = env.IVerilog(sim_name, src_sim)
     vcd_file = env.VCD(sout)
     # 'do_initial_zoom_fit' does max zoom only if .gtkw file not found.
     waves = env.Alias('sim', vcd_file, 'gtkwave {0} {1} {2}.gtkw'.format(
         '--rcvar "splash_disable on" --rcvar "do_initial_zoom_fit 1"',
-        vcd_file[0], SIMULNAME))
+        vcd_file[0], sim_name))
     AlwaysBuild(waves)
 
+
+# --- Testing
+# Since the simulation targets are dynamic due to the testbench selection, we 
+# create them only when running simulation.
+if 'test' in COMMAND_LINE_TARGETS: 
+    assert 'sim' not in COMMAND_LINE_TARGETS, COMMAND_LINE_TARGETS
+    if TESTBENCH:
+        # Explicit testbench file name is given via --testbench. We test just that one.
+        test_tbs= [ TESTBENCH ]
+    else:
+        # No --testbench flag specified. We will test all them.
+        if len(list_tb) == 0:
+            print('Error: no testbenchs found for simulation.')
+            Exit(1)
+        test_tbs= list_tb  # All testbenches.
+    tests = [] # Targets of all tests
+    for test_tb in test_tbs:
+        # Create a list of source files. All the modules + the current testbench.
+        src_test = []
+        src_test.extend(src_synth)  # All the .v files.
+        src_test.append(test_tb)
+        # Create the targets for the 'out' and 'vcd' files of the testbench.
+        # NOTE: Remove the two AlwaysBuild() calls below for an incremental test. Fast, correct,
+        # but may confuse the user seeing nothing happens. 
+        test_name, _ = os.path.splitext(test_tb)  #e.g. my_module_tb
+        test_out_target = env.IVerilog(test_name, src_test)
+        AlwaysBuild(test_out_target)
+        test_vcd_target = env.VCD(test_out_target)
+        AlwaysBuild(test_vcd_target)
+        test_target = env.Alias(test_name, [test_out_target, test_vcd_target])
+        tests.append(test_target)
+    # Create a target for the test command that depends on all the test targets.
+    tests_target = env.Alias('test', tests)
+    AlwaysBuild(tests_target)
+
 # -- Verilator builder
 verilator = Builder(
     action='verilator --lint-only -Wno-TIMESCALEMOD {0} {1} {2} {3} $SOURCES'.format(

docs/source/user_guide/index.rst

@@ -91,6 +91,7 @@ Project Commands
     project_commands/cmd_clean
     project_commands/cmd_lint
     project_commands/cmd_sim
+    project_commands/cmd_test
     project_commands/cmd_time
     project_commands/cmd_upload
     project_commands/cmd_verify

test/code_commands/test_test.py

@@ -0,0 +1,10 @@
+from apio.commands.sim import cli as cmd_test
+
+
+def test_test(clirunner, configenv):
+    with clirunner.isolated_filesystem():
+        configenv()
+        result = clirunner.invoke(cmd_test, ['--board', 'icezum'])
+        assert result.exit_code != 0
+        if result.exit_code == 1:
+            assert 'apio install iverilog' in result.output