opencos-eda 0.2.47__py3-none-any.whl → 0.2.49__py3-none-any.whl

opencos/tests/test_eda.py

@@ -7,6 +7,12 @@ If you want to run this, consider running from the root of opencos repo:
     > python3 -m pytest --verbose opencos/*/*.py
     > python3 -m pytest -rx opencos/*/*.py
  which avoids using any pip installed opencos.eda
+
+Throughout this file, if you see:
+   assert rc > 1
+It is not a typo. We would prefer all expected errors to be caught and reported by
+eda.py. Python errors tend to return with rc=1, and those are problematic for us
+and should be more gracefully handled.
 '''
 
 # pylint: disable=R0801 # (similar lines in 2+ files)
@@ -18,7 +24,8 @@ from contextlib import redirect_stdout, redirect_stderr
 
 import pytest
 
-from opencos import eda, util, eda_tool_helper
+from opencos import eda, eda_tool_helper
+from opencos.utils.markup_helpers import yaml_safe_load
 from opencos.tests import helpers
 from opencos.tests.helpers import eda_wrap, eda_sim_wrap, eda_elab_wrap, \
     Helpers
@@ -89,7 +96,7 @@ class TestsRequiresVerilator( # pylint: disable=too-many-public-methods
         chdir_remove_work_dir('../../lib')
         rc = eda_wrap('synth', '--tool', 'verilator', 'oclib_fifo')
         print(f'{rc=}')
-        assert rc != 0
+        assert rc > 1
 
 
     def test_args_sim(self):
@@ -228,7 +235,7 @@ class TestsRequiresVerilator( # pylint: disable=too-many-public-methods
         # want to use the xfail pytest decorator.
         rc = eda_sim_wrap('--xilinx', '--tool', 'verilator', 'oclib_fifo_test')
         print(f'{rc=}')
-        assert rc != 0
+        assert rc > 1
 
     def test_more_plusargs_sim(self):
         '''Test that unprocessed plusargs become sim-plusargs on CLI'''
@@ -266,7 +273,7 @@ class TestsRequiresVerilator( # pylint: disable=too-many-public-methods
         rc = eda.main('multi', 'sim', '--fail-if-no-targets', '--seed=1', '--xilinx', '--tool',
                       'verilator', 'oclib_fifo_test')
         print(f'{rc=}')
-        assert rc != 0
+        assert rc > 1
 
     def test_args_multi_sim_no_targets_should_fail(self):
         '''Checks that: eda multi --fail-if-no-targets; will fail if no targets expanded'''
@@ -275,7 +282,7 @@ class TestsRequiresVerilator( # pylint: disable=too-many-public-methods
         rc = eda.main('multi', 'sim', '--fail-if-no-targets', '--seed=1', '--tool', 'verilator',
                       'no_targets*')
         print(f'{rc=}')
-        assert rc != 0
+        assert rc > 1
 
     def test_elab_verilator_no_deps_files_involved(self):
         '''Test that inferring the --top from last file in provides files works.'''
@@ -295,7 +302,7 @@ class TestsRequiresVerilator( # pylint: disable=too-many-public-methods
         eda_config_yml_path = os.path.join(
             os.getcwd(), 'eda.work', 'oclib_fifo.elab', 'eda_output_config.yml'
         )
-        data = util.yaml_safe_load(eda_config_yml_path)
+        data = yaml_safe_load(eda_config_yml_path)
         assert 'args' in data
         assert data['args'].get('top', '') == 'oclib_fifo'
         assert 'config' in data
@@ -315,7 +322,7 @@ class TestsRequiresVerilator( # pylint: disable=too-many-public-methods
         eda_config_yml_path = os.path.join(
             os.getcwd(), 'eda.work', 'oclib_fifo.elab', 'eda_output_config.yml'
         )
-        data = util.yaml_safe_load(eda_config_yml_path)
+        data = yaml_safe_load(eda_config_yml_path)
         assert 'args' in data
         assert data['args'].get('top', '') == 'oclib_fifo'
         assert 'config' in data
@@ -333,7 +340,7 @@ class TestsRequiresVerilator( # pylint: disable=too-many-public-methods
         cmd_list +=' oclib_assert_pkg.sv oclib_pkg.sv oclib_fifo.sv'.split()
         rc = eda.main(*cmd_list)
         print(f'{rc=}')
-        assert rc != 0
+        assert rc > 1
 
     def test_config_reduced_yml(self):
         '''Test using provided EDA --config-yml=eda_config_reduced.yml, confirm installed w/ pip'''
@@ -360,7 +367,7 @@ class TestsRequiresVerilator( # pylint: disable=too-many-public-methods
         assert rc == 0
         eda_config_yml_path = os.path.join(os.getcwd(), 'eda.work', 'oclib_fifo_test.sim',
                                            'eda_output_config.yml')
-        data = util.yaml_safe_load(eda_config_yml_path)
+        data = yaml_safe_load(eda_config_yml_path)
         # make sure this config was actually used. We no longer re-add it to args
         # (it won't show up in 'original_args') it will will show up in the config though:
         used_yml_fname = data['config']['config-yml']
@@ -422,16 +429,15 @@ class TestsRequiresVerilator( # pylint: disable=too-many-public-methods
 class TestMissingDepsFileErrorMessages(Helpers):
     '''Test for missing DEPS.yml file, using 'eda export' to avoid tools.'''
     DEFAULT_DIR = os.path.join(THISPATH, 'deps_files', 'no_deps_here', 'empty')
-    DEFAULT_LOG = 'eda.log'
 
     def test_bad0(self):
         '''Looks for target_bad0, but there is no DEPS file in .'''
         self.chdir()
         rc = self.log_it(command_str='export target_bad0')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
-            'Trying to resolve command-line target=./target_bad0: was not found',
-            'in deps_file=None, possible targets in deps file = []',
+            'Trying to resolve command-line target=./target_bad0:'
+            ' but path ./ has no DEPS markup file',
             windows_path_support=True
         )
 
@@ -444,7 +450,6 @@ class TestDepsResolveErrorMessages(Helpers):
     linenumber information is printed when available.'''
 
     DEFAULT_DIR = os.path.join(THISPATH, 'deps_files', 'error_msgs')
-    DEFAULT_LOG = 'eda.log'
 
     # files foo.sv, foo2.sv, target_bad0.sv, and target_bad1.sv exist.
     # files missing*.sv and targets missing* do not exist.
@@ -480,7 +485,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''Tests missing file in DEPS target using implicit deps str style'''
         self.chdir()
         rc = self.log_it(command_str='export target_bad0')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "target=./missing0.sv (file?): called from ./DEPS.yml::target_bad0::line=20,",
             "File=missing0.sv not found in directory=.",
@@ -491,7 +496,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''Tests missing file in DEPS target using implicit deps list style'''
         self.chdir()
         rc = self.log_it(command_str='export target_bad1')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "target=./missing1.sv (file?): called from ./DEPS.yml::target_bad1::line=24,",
             "File=missing1.sv not found in directory=.",
@@ -502,7 +507,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''Tests missing file in DEPS target using deps as str style'''
         self.chdir()
         rc = self.log_it(command_str='export target_bad2')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "target=./missing2.sv (file?): called from ./DEPS.yml::target_bad2::line=28,",
             "File=missing2.sv not found in directory=.",
@@ -513,7 +518,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''Tests missing file in DEPS target using deps as list style'''
         self.chdir()
         rc = self.log_it(command_str='export target_bad3')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "target=./missing3.sv (file?): called from ./DEPS.yml::target_bad3::line=33,",
             "File=missing3.sv not found in directory=.",
@@ -524,7 +529,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''EDA on a bad target (bad target within deps of 'target_bad4'), explicit deps str'''
         self.chdir()
         rc = self.log_it(command_str='export target_bad4')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "target=./missing_target4: called from ./DEPS.yml::target_bad4::line=39,",
             "Target not found in deps_file=./DEPS.yml",
@@ -535,7 +540,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''EDA on a bad target (bad target within deps of 'target_bad4'), explicit deps list'''
         self.chdir()
         rc = self.log_it(command_str='export target_bad5')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "target=./missing_target5: called from ./DEPS.yml::target_bad5::line=43,",
             "Target not found in deps_file=./DEPS.yml",
@@ -546,7 +551,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''EDA on a bad target (bad target within deps of 'target_bad4'), deps str'''
         self.chdir()
         rc = self.log_it(command_str='export target_bad6')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "target=./missing_target6: called from ./DEPS.yml::target_bad6::line=47,",
             "Target not found in deps_file=./DEPS.yml",
@@ -558,7 +563,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''EDA on a bad target (bad target within deps of 'target_bad4'), deps list'''
         self.chdir()
         rc = self.log_it(command_str='export target_bad7')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "target=./missing_target7: called from ./DEPS.yml::target_bad7::line=52,",
             "Target not found in deps_file=./DEPS.yml",
@@ -581,7 +586,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''EDA calling a non-existent target in DEPS file'''
         self.chdir()
         rc = self.log_it(command_str='export nope_target0')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "Trying to resolve command-line target=./nope_target0: was not",
             "found in deps_file=./DEPS.yml, possible targets in deps file = ['foo'",
@@ -592,7 +597,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''EDA calling a non-existent target in DEPS file, with file that exists.'''
         self.chdir()
         rc = self.log_it(command_str='export foo.sv nope_target1')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "Trying to resolve command-line target=./nope_target1: was not",
             "found in deps_file=./DEPS.yml, possible targets in deps file = ['foo'",
@@ -603,7 +608,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''EDA calling a non-existent file w/out DEPS'''
         self.chdir()
         rc = self.log_it(command_str='export nope_file0.sv')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "Trying to resolve command-line target=./nope_file0.sv",
             "(file?): File=nope_file0.sv not found in directory=.",
@@ -614,7 +619,7 @@ class TestDepsResolveErrorMessages(Helpers):
         '''EDA calling a non-existent file w/out DEPS, and a file that does exist.'''
         self.chdir()
         rc = self.log_it(command_str='export foo2.sv nope_file1.sv')
-        assert rc != 0
+        assert rc > 1
         assert self.is_in_log(
             "Trying to resolve command-line target=./nope_file1.sv",
             "(file?): File=nope_file1.sv not found in directory=.",
@@ -682,14 +687,14 @@ class TestDepsReqs:
         chdir_remove_work_dir('deps_files/non_sv_reqs')
         cmd_list = 'sim should_fail_foo_test5'.split()
         rc = eda.main(*cmd_list)
-        assert rc != 0
+        assert rc > 1
 
     def test_deps_reqs6(self):
         '''Test that should fail due bad file in deps section (none in reqs)'''
         chdir_remove_work_dir('deps_files/non_sv_reqs')
         cmd_list = 'sim should_fail_foo_test6'.split()
         rc = eda.main(*cmd_list)
-        assert rc != 0
+        assert rc > 1
 
 
 @pytest.mark.parametrize("command", ['sim', 'shell'])
@@ -741,13 +746,15 @@ def test_deps_command_order(command):
     work_dir = os.path.join(
         THISPATH, 'deps_files', 'command_order', 'eda.work', f'target_test.{command}'
     )
+    # Note that eda will write out the returncode INFO line to tee'd log files, so
+    # there is more in the log file than "hi" or "bye".
     with open(os.path.join(work_dir, 'target_echo_hi__shell_0.log'), encoding='utf-8') as f:
-        text = ''.join(f.readlines()).strip()
-        assert text in ['hi', '"hi"', '\\"hi\\"']
+        text = ' '.join(f.readlines()).strip()
+        assert any(text.startswith(x) for x in ['hi', '"hi"', '\\"hi\\"'])
     # Added check, one of the targets uses a custom 'tee' file name, instead of the default log.
     with open(os.path.join(work_dir, 'custom_tee_echo_bye.log'), encoding='utf-8') as f:
         text = ''.join(f.readlines()).strip()
-        assert text in ['bye', '"bye"', '\\"bye\\"']
+        assert any(text.startswith(x) for x in ['bye', '"bye"', '\\"bye\\"'])
 
 
 @pytest.mark.skipif('verilator' not in tools_loaded, reason="requires verilator")
@@ -815,32 +822,31 @@ class TestDepsNoFilesTargets(Helpers):
         # Using this b/c DEPS.toml has single target.
         chdir_remove_work_dir('./deps_files/test_deps_toml')
         rc = eda_wrap('sim', '--tool', 'verilator', 'target_whoops')
-        assert rc == 1
+        assert rc > 1
 
     def test_eda_sim__no_files_or_targets_shouldfail(self):
         '''This test should fail, there is DEPS.yml (empty, no implicit target), or missing file'''
         chdir_remove_work_dir('./deps_files/no_deps_here')
         rc = eda_wrap('sim', '--tool', 'verilator')
-        assert rc == 1
+        assert rc > 1
 
     def test_eda_sim__no_files_or_targets_with_top_shouldfail(self):
         '''This test should fail, there is DEPS.yml (empty, no implicit target), or missing file'''
         chdir_remove_work_dir('./deps_files/no_deps_here')
         rc = eda_wrap('sim', '--tool', 'verilator', '--top', 'empty_file')
-        assert rc == 1
+        assert rc > 1
 
 
 class TestDepsTags(Helpers):
     '''Series of tests for DEPS - target - tags, in ./deps_files/tags_with_tools'''
     DEFAULT_DIR = os.path.join(THISPATH, 'deps_files', 'tags_with_tools')
-    DEFAULT_LOG = 'eda.log'
 
     @pytest.mark.skipif('verilator' not in tools_loaded, reason="requires verilator")
     def test_tags_with_tools_verilator(self):
         '''test for DEPS target that hits with-tools: verilator, so that
         additional args are applied from the DEPS tag.'''
         self.chdir()
-        logfile = 'verilator_eda.log'
+        logfile = '.pytest.verilator_eda.log'
         rc = self.log_it('sim --tool verilator target_test', logfile=logfile)
         assert rc == 0
 
@@ -859,7 +865,7 @@ class TestDepsTags(Helpers):
         AKA, lets you replace all the Verilator waivers to the DEPS target that only affect
         with-tools: verilator'''
         self.chdir()
-        logfile = 'target_with_replace_config_tools_test.log'
+        logfile = '.pytest.target_with_replace_config_tools_test.log'
         rc = self.log_it('sim --tool verilator target_with_replace_config_tools_test',
                          logfile=logfile)
         assert rc == 0
@@ -877,7 +883,7 @@ class TestDepsTags(Helpers):
         AKA, lets you add Verilator waivers to the DEPS target that only affect
         with-tools: verilator'''
         self.chdir()
-        logfile = 'target_with_additive_config_tools_test.log'
+        logfile = '.pytest.target_with_additive_config_tools_test.log'
         rc = self.log_it('sim --tool verilator --debug target_with_additive_config_tools_test',
                          logfile=logfile)
         assert rc == 0
@@ -897,7 +903,7 @@ class TestDepsTags(Helpers):
         apply the arg --lint-only in the DEPS tag, and instead run the
         full simulation.'''
         self.chdir()
-        logfile = 'vivado_eda.log'
+        logfile = '.pytest.vivado_eda.log'
         rc = self.log_it('sim --tool vivado target_test', logfile=logfile)
         assert rc == 0
 
@@ -916,7 +922,7 @@ class TestDepsTags(Helpers):
     def test_tags_with_tools_add_incdirs(self):
         '''test for DEPS target with tag that adds incdirs'''
         self.chdir()
-        logfile = 'target_foo_sv_add_incdirs.log'
+        logfile = '.pytest.target_foo_sv_add_incdirs.log'
         rc = self.log_it('elab --tool verilator target_foo_sv_add_incdirs',
                          logfile=logfile)
         assert rc == 0
@@ -931,7 +937,7 @@ class TestDepsTags(Helpers):
     def test_tags_with_tools_add_defines(self):
         '''test for DEPS target with tag that adds defines'''
         self.chdir()
-        logfile = 'target_foo_sv_add_defines.log'
+        logfile = '.pytest.target_foo_sv_add_defines.log'
         rc = self.log_it('elab --tool verilator --debug target_foo_sv_add_defines',
                          logfile=logfile)
         assert rc == 0

opencos/tests/test_eda_elab.py

@@ -80,7 +80,9 @@ def test_elab_tool_cant_run_sim(tool):
     rc = 0
     try:
         rc = eda_wrap('sim', '--tool', tool, 'oclib_fifo')
+        print(f'{rc=}')
+        assert rc > 1
     except NotImplementedError:
-        rc = 1
-    print(f'{rc=}')
-    assert rc != 0
+        rc = 3
+        print(f'{rc=} (forced to 3 for NotImplementedError)')
+    assert rc > 1

opencos/tests/test_eda_synth.py

@@ -53,7 +53,7 @@ class Tests:
                    ' target_doesnt_exist*').split()
         rc = eda.main(*cmdlist)
         print(f'{rc=}')
-        assert rc != 0
+        assert rc > 1
 
     def test_args_multi_synth_oclib_fifos(self, tool, command):
         '''This should be 4 jobs and takes ~15 seconds for synth.'''

opencos/tests/test_oc_cli.py

@@ -6,7 +6,7 @@ If you want to run this, consider running from the root of opencos repo:
 which avoids using any pip installed opencos.eda
 '''
 
-from opencos import oc_cli
+from opencos.hw import oc_cli
 
 def test_args_help():
     '''simple test for: oc_cli --help'''

opencos/tests/test_tools.py

@@ -6,12 +6,13 @@ import os
 import sys
 import pytest
 
-from opencos import eda, util, eda_tool_helper, eda_base
+from opencos import eda, eda_tool_helper, eda_base
 
 from opencos.tools.verilator import ToolVerilator
 from opencos.tools.vivado import ToolVivado
 from opencos.tests import helpers
 from opencos.tests.helpers import eda_wrap
+from opencos.utils.markup_helpers import yaml_safe_load
 
 
 thispath = os.path.dirname(__file__)
@@ -129,7 +130,7 @@ def test_vivado_tool_defines():
         os.getcwd(), 'eda.work', 'oclib_fifo.elab', 'eda_output_config.yml'
     )
 
-    data = util.yaml_safe_load(eda_config_yml_path)
+    data = yaml_safe_load(eda_config_yml_path)
     assert 'args' in data
     assert data['args'].get('top', '') == 'oclib_fifo'
     assert 'config' in data

opencos/tools/iverilog.py

@@ -7,9 +7,9 @@ import shutil
 import subprocess
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.eda_base import Tool
 from opencos.commands import CommandSim
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 
 class ToolIverilog(Tool):
@@ -108,7 +108,7 @@ class CommandSimIverilog(CommandSim, ToolIverilog):
             ]
         )
 
-        util.write_eda_config_and_args(dirpath=self.args['work-dir'], command_obj_ref=self)
+        self.write_eda_config_and_args()
 
     def compile(self):
         if self.args['stop-before-compile']:

opencos/tools/modelsim_ase.py

@@ -8,9 +8,9 @@ Contains classes for ToolModelsimAse, CommandSimModelsimAse, CommandElabModelsim
 import os
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.commands import CommandSim
 from opencos.tools.questa import ToolQuesta
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 class ToolModelsimAse(ToolQuesta):
     '''ToolModelsimAse used by opencos.eda for --tool=modelsim_ase'''
@@ -77,7 +77,7 @@ class CommandSimModelsimAse(CommandSim, ToolModelsimAse):
             command_lists = [['./pre_compile_dep_shell_commands.sh']] + vsim_command_lists
         )
 
-        util.write_eda_config_and_args(dirpath=self.args['work-dir'], command_obj_ref=self)
+        self.write_eda_config_and_args()
 
     def compile(self):
         if self.args['stop-before-compile']:

opencos/tools/riviera.py

@@ -11,8 +11,8 @@ import shutil
 import subprocess
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.tools.modelsim_ase import ToolModelsimAse, CommandSimModelsimAse
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 class ToolRiviera(ToolModelsimAse):
     '''ToolRiviera used by opencos.eda for --tool=riviera'''

opencos/tools/slang.py

@@ -10,9 +10,9 @@ import shutil
 import subprocess
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.eda_base import Tool
 from opencos.commands import CommandElab
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 
 class ToolSlang(Tool):

opencos/tools/surelog.py

@@ -7,9 +7,9 @@ import shutil
 import subprocess
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.eda_base import Tool
 from opencos.commands import CommandElab
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 
 class ToolSurelog(Tool):

opencos/tools/verilator.py

@@ -10,9 +10,9 @@ import shutil
 import subprocess
 
 from opencos import util
-from opencos.util import sanitize_defines_for_sh
 from opencos.eda_base import Tool
 from opencos.commands import CommandSim
+from opencos.utils.str_helpers import sanitize_defines_for_sh
 
 class ToolVerilator(Tool):
     '''ToolVerilator used by opencos.eda for --tool=verilator'''

opencos/tools/vivado.py

@@ -182,7 +182,7 @@ class CommandSimVivado(CommandSim, ToolVivado):
                                           ['./simulate.sh'],
                                       ])
 
-        util.write_eda_config_and_args(dirpath=self.args['work-dir'], command_obj_ref=self)
+        self.write_eda_config_and_args()
 
     def compile(self):
         if self.args['stop-before-compile']:

opencos/tools/yosys.py

@@ -9,9 +9,10 @@ import os
 import shutil
 import subprocess
 
-from opencos import util
+from opencos import util, eda_config
 from opencos.eda_base import Tool, get_eda_exec
 from opencos.commands import CommandSynth, CommandLec
+from opencos.utils.markup_helpers import yaml_safe_load
 
 
 def get_commands_to_run_scriptfiles(
@@ -543,8 +544,8 @@ class CommandLecYosys(CommandLec, ToolYosys):
         '''Returns the top name given the design number that we synthesized'''
 
         work_dir = self.synth_work_dirs[design_num]
-        output_cfg_fpath = os.path.join(work_dir, util.EDA_OUTPUT_CONFIG_FNAME)
-        data = util.yaml_safe_load(output_cfg_fpath)
+        output_cfg_fpath = os.path.join(work_dir, eda_config.EDA_OUTPUT_CONFIG_FNAME)
+        data = yaml_safe_load(output_cfg_fpath)
         top = data.get('args', {}).get('top', '')
         if not top:
             self.error(f'"top" not found in synth run from {work_dir=} in',