Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 06:38:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Fix handling of module scope when checking exported Spicy types for collisions

Browse source 
When checking exported Spicy types for collisions with existing Zeek
types we previously would also check whether they collide with names in
global scope, i.e., we didn't provide a `no_global` arg to
`detail::lookup_ID` which defaulted to false (since we also provided a
module name I'd argue that the behavior of that function is confusing
and probably error-prone -- like seen here).

This meant that e.g., a Spicy enum `foo::Direction` (automatically in
implicit Spicy module scope) would be detected to collide with the
existing Zeek `Direction` enum.

With this patch we use the `lookup_ID` API correctly and do not check
against potential collisions with globals anymore since it is not
needed.

Closes #3279.
This commit is contained in:
Benjamin Bannier 2023-09-13 15:40:58 +02:00
parent 17347df036
commit 4f0f22ec78
2 changed files with 21 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/spicy/manager.cc
View file

@ -215,7 +215,7 @@ void Manager::registerPacketAnalyzer(const std::string& name, const std::string&
void Manager::registerType(const std::string& id, const TypePtr& type) {
auto [ns, local] = parseID(id);
if ( const auto& old = detail::lookup_ID(local.c_str(), ns.c_str()) ) {
if ( const auto& old = detail::lookup_ID(local.c_str(), ns.c_str(), true) ) {
// This is most likely to trigger for IDs that other Spicy modules
// register. If we two Spicy modules need the same type, that's ok as
// long as they match.

20
testing/btest/spicy/export-type-collision-with-global.spicy Normal file
View file

@ -0,0 +1,20 @@
# @TEST-REQUIRES: have-spicy
#
# @TEST-EXEC: spicyz -d -o foo.hlto foo.spicy foo.evt
# @TEST-EXEC: zeek -NN Zeek::Spicy foo.hlto >output1 2>&1
# @TEST-EXEC: ZEEK_SPICY_MODULE_PATH=$PWD zeek -B all -NN Zeek::Spicy >output2 2>&1
# @TEST-EXEC: diff output1 output2 1>&2
#
# @TEST-DOC: This validates that an exported Spicy name with local part identical with a Zeek name in global scope does not clash. Regression test for #3279.
# @TEST-START-FILE foo.spicy
module foo;
# `foo::Direction` has the same local part as Zeek's `::Direction`.
public type Direction = enum { a };
public type Other = enum { a };
# @TEST-END-FILE
# @TEST-START-FILE foo.evt
import foo;
# @TEST-END-FILE