Skip to content

fix(drc): preserve violations in nested report categories #4696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jinchuntan wants to merge 1 commit into
base: master
Choose a base branch
from
+84 −4
Open

fix(drc): preserve violations in nested report categories #4696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 77 additions & 2 deletions flow/test/test_convertDrc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,83 @@ def make_mock_item(values, is_visited=False, tags_str="", comment=None):
def make_mock_category(name, description, rdb_id, num_items, items):
cat = MagicMock()
cat.name.return_value = name
cat.path.return_value = name
cat.description = description
cat.rdb_id.return_value = rdb_id
cat.num_items.return_value = num_items
return cat, items


class TestConvertDrc(unittest.TestCase):
def test_nested_categories_keep_rules_with_the_same_name(self):
metal1, _ = make_mock_category("metal1", "Metal 1", 1, 1, [])
metal2, _ = make_mock_category("metal2", "Metal 2", 2, 1, [])
width1, _ = make_mock_category("width", "Metal 1 width", 3, 1, [])
width2, _ = make_mock_category("width", "Metal 2 width", 4, 1, [])
width1.path.return_value = "metal1.width"
width2.path.return_value = "metal2.width"
metal1.each_sub_category.return_value = iter([width1])
metal2.each_sub_category.return_value = iter([width2])
items = {
3: [make_mock_item([make_box_value(0, 0, 1, 1)])],
4: [make_mock_item([make_box_value(2, 2, 3, 3)])],
}
rdb = MagicMock()
rdb.each_category.return_value = iter([metal1, metal2])
rdb.each_item_per_category.side_effect = lambda category_id: iter(
items.get(category_id, [])
)

categories = convert_drc(rdb)["category"]

self.assertEqual(len(categories["metal1.width"]["violations"]), 1)
self.assertEqual(len(categories["metal2.width"]["violations"]), 1)
self.assertEqual(categories["metal2.width"]["description"], "Metal 2 width")
self.assertEqual(
categories["metal2.width"]["violations"][0]["shape"][0]["points"],
[{"x": 2, "y": 2}, {"x": 3, "y": 3}],
)

def test_categories_are_traversed_beyond_one_child_level(self):
metal, _ = make_mock_category("metal1", "Metal 1", 1, 1, [])
width, _ = make_mock_category("width", "Width", 2, 1, [])
minimum, _ = make_mock_category("minimum", "Minimum width", 3, 1, [])
minimum.path.return_value = "metal1.width.minimum"
metal.each_sub_category.return_value = iter([width])
width.each_sub_category.return_value = iter([minimum])
item = make_mock_item([make_box_value(0, 0, 1, 1)])
rdb = MagicMock()
rdb.each_category.return_value = iter([metal])
rdb.each_item_per_category.side_effect = lambda category_id: iter(
[item] if category_id == 3 else []
)

categories = convert_drc(rdb)["category"]

self.assertEqual(len(categories["metal1.width.minimum"]["violations"]), 1)

def test_literal_dotted_name_does_not_overwrite_a_category_path(self):
metal, _ = make_mock_category("metal1", "Metal 1", 1, 1, [])
width, _ = make_mock_category("width", "Nested rule", 2, 1, [])
literal, _ = make_mock_category("metal1.width", "Flat rule", 3, 1, [])
width.path.return_value = "metal1.width"
literal.path.return_value = "'metal1.width'"
metal.each_sub_category.return_value = iter([width])
items = {
2: [make_mock_item([make_box_value(0, 0, 1, 1)])],
3: [make_mock_item([make_box_value(2, 2, 3, 3)])],
}
rdb = MagicMock()
rdb.each_category.return_value = iter([metal, literal])
rdb.each_item_per_category.side_effect = lambda category_id: iter(
items.get(category_id, [])
)

categories = convert_drc(rdb)["category"]

self.assertEqual(categories["metal1.width"]["description"], "Nested rule")
self.assertEqual(categories["'metal1.width'"]["description"], "Flat rule")

def test_empty_rdb(self):
rdb = MagicMock()
rdb.each_category.return_value = iter([])
Expand All @@ -153,6 +223,7 @@ def test_box_violation(self):

cat = MagicMock()
cat.name.return_value = "metal1.min_width"
cat.path.return_value = "'metal1.min_width'"
cat.description = "Minimum width violation"
cat.rdb_id.return_value = 1
cat.num_items.return_value = 1
Expand All @@ -163,7 +234,7 @@ def test_box_violation(self):

result = convert_drc(rdb)

violations = result["category"]["metal1.min_width"]["violations"]
violations = result["category"]["'metal1.min_width'"]["violations"]
self.assertEqual(len(violations), 1)
self.assertEqual(len(violations[0]["shape"]), 1)
shape = violations[0]["shape"][0]
Expand All @@ -177,6 +248,7 @@ def test_edge_violation(self):

cat = MagicMock()
cat.name.return_value = "metal1.spacing"
cat.path.return_value = "'metal1.spacing'"
cat.description = "Spacing violation"
cat.rdb_id.return_value = 2
cat.num_items.return_value = 1
Expand All @@ -187,7 +259,7 @@ def test_edge_violation(self):

result = convert_drc(rdb)

violations = result["category"]["metal1.spacing"]["violations"]
violations = result["category"]["'metal1.spacing'"]["violations"]
shape = violations[0]["shape"][0]
self.assertEqual(shape["type"], "line")
self.assertEqual(shape["points"][0], {"x": 10, "y": 20})
Expand All @@ -199,6 +271,7 @@ def test_waived_violation(self):

cat = MagicMock()
cat.name.return_value = "rule1"
cat.path.return_value = "rule1"
cat.description = "Rule 1"
cat.rdb_id.return_value = 1
cat.num_items.return_value = 1
Expand All @@ -218,6 +291,7 @@ def test_text_in_comment(self):

cat = MagicMock()
cat.name.return_value = "rule1"
cat.path.return_value = "rule1"
cat.description = "Rule 1"
cat.rdb_id.return_value = 1
cat.num_items.return_value = 1
Expand All @@ -237,6 +311,7 @@ def test_comment_with_text(self):

cat = MagicMock()
cat.name.return_value = "rule1"
cat.path.return_value = "rule1"
cat.description = "Rule 1"
cat.rdb_id.return_value = 1
cat.num_items.return_value = 1
Expand Down
9 changes: 7 additions & 2 deletions flow/util/convertDrc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ def convert_drc(rdb):

ordb = {"source": source, "description": "KLayout DRC conversion", "category": {}}

for category in rdb.each_category():
def iter_categories(categories):
for category in categories:
yield category
yield from iter_categories(category.each_sub_category())

for category in iter_categories(rdb.each_category()):
if category.num_items() == 0:
# ignore categories with no data
continue
Expand All @@ -21,7 +26,7 @@ def convert_drc(rdb):
"source": source,
"violations": [],
}
ordb["category"][category.name()] = ordb_category
ordb["category"][category.path()] = ordb_category

for item in rdb.each_item_per_category(category.rdb_id()):
violation = {
Expand Down