Skip to content

Commit

Permalink
test: adding test for pbjs static code generation
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-fenster committed Apr 28, 2021
1 parent 6c4d307 commit 343e127
Show file tree
Hide file tree
Showing 3 changed files with 89 additions and 0 deletions.
4 changes: 4 additions & 0 deletions package.json
Expand Up @@ -56,7 +56,10 @@
"browserify-wrap": "^1.0.2",
"bundle-collapser": "^1.3.0",
"chalk": "^4.0.0",
"escodegen": "^1.13.0",
"eslint": "^7.0.0",
"espree": "^7.1.0",
"estraverse": "^5.1.0",
"gh-pages": "^3.0.0",
"git-raw-commits": "^2.0.3",
"git-semver-tags": "^4.0.0",
Expand All @@ -74,6 +77,7 @@
"tape": "^5.0.0",
"tslint": "^6.0.0",
"typescript": "^3.7.5",
"uglify-js": "^3.7.7",
"vinyl-buffer": "^1.0.1",
"vinyl-fs": "^3.0.3",
"vinyl-source-stream": "^2.0.0"
Expand Down
72 changes: 72 additions & 0 deletions tests/cli.js
@@ -0,0 +1,72 @@
// A minimal test for pbjs tool targets.

var tape = require("tape");
var path = require("path");
var Module = require("module");
var protobuf = require("..");

tape.test("pbjs generates static code", function(test) {
// Alter the require cache to make the cli/targets/static work since it requires "protobufjs"
// and we don't want to mess with "npm link"
var savedResolveFilename = Module._resolveFilename;
Module._resolveFilename = function(request, parent) {
if (request.startsWith("protobufjs")) {
return request;
}
return savedResolveFilename(request, parent);
};
require.cache.protobufjs = require.cache[path.resolve("index.js")];

var staticTarget = require("../cli/targets/static");

var root = protobuf.loadSync("tests/data/cli/test.proto");
root.resolveAll();

staticTarget(root, {
create: true,
decode: true,
encode: true,
convert: true,
}, function(err, jsCode) {
test.error(err, 'static code generation worked');

// jsCode is the generated code; we'll eval it
// (since this is what we normally does with the code, right?)
// This is a test code. Do not use this in production.
var $protobuf = protobuf;
eval(jsCode);

var OneofContainer = protobuf.roots.default.OneofContainer;
var Message = protobuf.roots.default.Message;
test.ok(OneofContainer, "type is loaded");
test.ok(Message, "type is loaded");

// Check that fromObject and toObject work for plain object
var obj = {
messageInOneof: {
value: 42,
},
regularField: "abc",
};
var obj1 = OneofContainer.toObject(OneofContainer.fromObject(obj));
test.deepEqual(obj, obj1, "fromObject and toObject work for plain object");

// Check that dynamic fromObject and toObject work for static instance
var root = protobuf.loadSync("tests/data/cli/test.proto");
var OneofContainerDynamic = root.lookup("OneofContainer");
var instance = new OneofContainer();
instance.messageInOneof = new Message();
instance.messageInOneof.value = 42;
instance.regularField = "abc";
var instance1 = OneofContainerDynamic.toObject(OneofContainerDynamic.fromObject(instance));
console.log(instance1);
// The following test fails: will be fixed by the next commit
test.deepEqual(instance, instance1, "fromObject and toObject work for instance of the static type");

test.end();
});

// Rollback all the require() related mess we made
delete require.cache.protobufjs;
Module._resolveFilename = savedResolveFilename;
});
13 changes: 13 additions & 0 deletions tests/data/cli/test.proto
@@ -0,0 +1,13 @@
syntax = "proto3";

message Message {
int32 value = 1;
}

message OneofContainer {
oneof some_oneof {
string string_in_oneof = 1;
Message message_in_oneof = 2;
}
string regular_field = 3;
}

0 comments on commit 343e127

Please sign in to comment.