Skip to content
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.

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

samples verify block by block #88

Closed
wants to merge 10 commits into from
137 changes: 137 additions & 0 deletions src/main/java/org/biscuitsec/biscuit/token/builder/parser/Parser.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,104 @@
import java.util.function.Function;

public class Parser {
public static Either<Map<Integer, List<Error>>, Block> datalog(long index, SymbolTable baseSymbols, String s) {
return datalog(index, baseSymbols, null, s);
}

/**
* Takes a datalog string with <code>\n</code> as datalog line separator. It tries to parse
* each line using fact, rule, check and scope sequentially.
*
* If one succeeds it returns Right(Block)
* else it returns a Map[lineNumber, List[Error]]
*
* @param index block index
* @param baseSymbols symbols table
* @param blockSymbols block's custom symbols table (added to baseSymbols)
* @param s datalog string to parse
* @return Either<Map<Integer, List<Error>>, Block>
*/
public static Either<Map<Integer, List<Error>>, Block> datalog(long index, SymbolTable baseSymbols, SymbolTable blockSymbols, String s) {
Block blockBuilder = new Block(index, baseSymbols);

// empty block code
if (s.isEmpty()) {
return Either.right(blockBuilder);
}

if (blockSymbols != null) {
blockSymbols.symbols.forEach(blockBuilder::addSymbol);
}

Map<Integer, List<Error>> errors = new HashMap<>();

s = removeCommentsAndWhitespaces(s);
String[] codeLines = s.split(";");

Stream.of(codeLines)
.zipWithIndex()
.forEach(indexedLine -> {
String code = indexedLine._1.strip();

if (!code.isEmpty()) {
int lineNumber = indexedLine._2;
System.out.println("NEW CODE LINE");
System.out.println(code);
List<Error> lineErrors = new ArrayList<>();

boolean parsed = false;
parsed = rule(code).fold(e -> {
lineErrors.add(e);
return false;
}, r -> {
blockBuilder.add_rule(r._2);
return true;
});

if (!parsed) {
parsed = scope(code).fold(e -> {
lineErrors.add(e);
return false;
}, r -> {
blockBuilder.add_scope(r._2);
return true;
});
}

if (!parsed) {
parsed = fact(code).fold(e -> {
lineErrors.add(e);
return false;
}, r -> {
blockBuilder.add_fact(r._2);
return true;
});
}

if (!parsed) {
parsed = check(code).fold(e -> {
lineErrors.add(e);
return false;
}, r -> {
blockBuilder.add_check(r._2);
return true;
});
}

if (!parsed) {
lineErrors.forEach(System.out::println);
errors.put(lineNumber, lineErrors);
}
}
});

if (!errors.isEmpty()) {
return Either.left(errors);
}

return Either.right(blockBuilder);
}

public static Either<Error, Tuple2<String, Fact>> fact(String s) {
Either<Error, Tuple2<String, Predicate>> res = fact_predicate(s);
if (res.isLeft()) {
Expand Down Expand Up @@ -671,4 +769,43 @@ public static Tuple2<String, String> take_while(String s, Function<Character, Bo

return new Tuple2<>(s.substring(0, index), s.substring(index));
}

public static String removeCommentsAndWhitespaces(String s) {
s = removeComments(s);
s = s.replace("\n", "").replace("\\\"", "\"").strip();
return s;
}

public static String removeComments(String str) {
StringBuilder result = new StringBuilder();
String remaining = str;

while (!remaining.isEmpty()) {
remaining = space(remaining); // Skip leading whitespace
if (remaining.startsWith("/*")) {
// Find the end of the multiline comment
remaining = remaining.substring(2); // Skip "/*"
String finalRemaining = remaining;
Tuple2<String, String> split = take_while(remaining, c -> !finalRemaining.startsWith("*/"));
remaining = split._2.length() > 2 ? split._2.substring(2) : ""; // Skip "*/"
} else if (remaining.startsWith("//")) {
// Find the end of the single-line comment
remaining = remaining.substring(2); // Skip "//"
Tuple2<String, String> split = take_while(remaining, c -> c != '\n' && c != '\r');
remaining = split._2;
if (!remaining.isEmpty()) {
result.append(remaining.charAt(0)); // Preserve line break
remaining = remaining.substring(1);
}
} else {
// Take non-comment text until the next comment or end of string
String finalRemaining = remaining;
Tuple2<String, String> split = take_while(remaining, c -> !finalRemaining.startsWith("/*") && !finalRemaining.startsWith("//"));
result.append(split._1);
remaining = split._2;
}
}

return result.toString();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -398,4 +398,95 @@ void testParens() throws org.biscuitsec.biscuit.error.Error.Execution {
assertEquals(new org.biscuitsec.biscuit.datalog.Term.Integer(9), value2);
assertEquals("(1 + 2) * 3", ex2.print(s2).get());
}

@Test
void testDatalogSucceeds() throws org.biscuitsec.biscuit.error.Error.Parser {
SymbolTable symbols = Biscuit.default_symbol_table();

String l1 = "fact1(1, 2)";
String l2 = "fact2(\"2\")";
String l3 = "rule1(2) <- fact2(\"2\")";
String l4 = "check if rule1(2)";
String toParse = String.join(";", Arrays.asList(l1, l2, l3, l4));

Either<Map<Integer, List<Error>>, Block> output = Parser.datalog(1, symbols, toParse);
assertTrue(output.isRight());

Block validBlock = new Block(1, symbols);
validBlock.add_fact(l1);
validBlock.add_fact(l2);
validBlock.add_rule(l3);
validBlock.add_check(l4);

output.forEach(block ->
assertArrayEquals(block.build().to_bytes().get(), validBlock.build().to_bytes().get())
);
}

@Test
void testDatalogSucceedsArrays() throws org.biscuitsec.biscuit.error.Error.Parser {
SymbolTable symbols = Biscuit.default_symbol_table();

String l1 = "check if [2, 3].union([2])";
String toParse = String.join(";", List.of(l1));

Either<Map<Integer, List<Error>>, Block> output = Parser.datalog(1, symbols, toParse);
assertTrue(output.isRight());

Block validBlock = new Block(1, symbols);
validBlock.add_check(l1);

output.forEach(block ->
assertArrayEquals(block.build().to_bytes().get(), validBlock.build().to_bytes().get())
);
}

@Test
void testDatalogSucceedsArraysContains() throws org.biscuitsec.biscuit.error.Error.Parser {
SymbolTable symbols = Biscuit.default_symbol_table();

String l1 = "check if [2019-12-04T09:46:41Z, 2020-12-04T09:46:41Z].contains(2020-12-04T09:46:41Z)";
String toParse = String.join(";", List.of(l1));

Either<Map<Integer, List<Error>>, Block> output = Parser.datalog(1, symbols, toParse);
assertTrue(output.isRight());

Block validBlock = new Block(1, symbols);
validBlock.add_check(l1);

output.forEach(block ->
assertArrayEquals(block.build().to_bytes().get(), validBlock.build().to_bytes().get())
);
}

@Test
void testDatalogFailed() {
SymbolTable symbols = Biscuit.default_symbol_table();

String l1 = "fact(1)";
String l2 = "check fact(1)"; // typo missing "if"
String toParse = String.join(";", Arrays.asList(l1, l2));

Either<Map<Integer, List<Error>>, Block> output = Parser.datalog(1, symbols, toParse);
assertTrue(output.isLeft());
}

@Test
void testDatalogRemoveComment() throws org.biscuitsec.biscuit.error.Error.Parser {
SymbolTable symbols = Biscuit.default_symbol_table();

String l0 = "// test comment";
String l1 = "fact1(1, 2);";
String l2 = "fact2(\"2\");";
String l3 = "rule1(2) <- fact2(\"2\");";
String l4 = "// another comment";
String l5 = "/* test multiline";
String l6 = "comment */ check if rule1(2);";
String l7 = " /* another multiline";
String l8 = "comment */";
String toParse = String.join("", Arrays.asList(l0, l1, l2, l3, l4, l5, l6, l7, l8));

Either<Map<Integer, List<Error>>, Block> output = Parser.datalog(1, symbols, toParse);
assertTrue(output.isRight());
}
}
47 changes: 47 additions & 0 deletions src/test/java/org/biscuitsec/biscuit/token/SamplesTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,47 @@ Stream<DynamicTest> jsonTest() {
return sample.testcases.stream().map(t -> process_testcase(t, publicKey, keyPair));
}

void compareBlocks(List<Block> sampleBlocks, List<org.biscuitsec.biscuit.token.Block> blocks) {
assertEquals(sampleBlocks.size(), blocks.size());
List<Tuple2<Block, org.biscuitsec.biscuit.token.Block>> comparisonList = IntStream.range(0, sampleBlocks.size())
.mapToObj(i -> new Tuple2<>(sampleBlocks.get(i), blocks.get(i)))
.collect(Collectors.toList());

// for each token we start from the base symbol table
SymbolTable baseSymbols = new SymbolTable();

io.vavr.collection.Stream.ofAll(comparisonList).zipWithIndex().forEach(indexedItem -> {
compareBlock(baseSymbols, indexedItem._2, indexedItem._1._1, indexedItem._1._2);
});
}

void compareBlock(SymbolTable baseSymbols, long sampleBlockIndex, Block sampleBlock, org.biscuitsec.biscuit.token.Block block) {
Option<PublicKey> sampleExternalKey = sampleBlock.getExternalKey();
List<PublicKey> samplePublicKeys = sampleBlock.getPublicKeys();
String sampleDatalog = sampleBlock.getCode().replace("\"","\\\"");
SymbolTable sampleSymbols = new SymbolTable(sampleBlock.symbols);

Either<Map<Integer, List<org.biscuitsec.biscuit.token.builder.parser.Error>>, org.biscuitsec.biscuit.token.builder.Block> outputSample = Parser.datalog(sampleBlockIndex, baseSymbols, sampleDatalog);
assertTrue(outputSample.isRight());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should show the input that was parsed and the error we got, otherwise we don't have any context to fix it


if (!block.publicKeys.isEmpty()) {
outputSample.get().addPublicKeys(samplePublicKeys);
}

if (!block.externalKey.isDefined()) {
sampleSymbols.symbols.forEach(baseSymbols::add);
} else {
SymbolTable freshSymbols = new SymbolTable();
sampleSymbols.symbols.forEach(freshSymbols::add);
outputSample.get().setExternalKey(sampleExternalKey);
}

System.out.println(outputSample.get().build().print(sampleSymbols));
System.out.println(block.symbols.symbols);
System.out.println(block.print(sampleSymbols));
assertArrayEquals(outputSample.get().build().to_bytes().get(), block.to_bytes().get());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here, this should show the expected and actual arrays, because the errors don't help https://github.com/biscuit-auth/biscuit-java/actions/runs/8622173639/job/23632740026?pr=88#step:5:6259

}

DynamicTest process_testcase(final TestCase testCase, final PublicKey publicKey, final KeyPair privateKey) {
return DynamicTest.dynamicTest(testCase.title + ": "+testCase.filename, () -> {
System.out.println("Testcase name: \""+testCase.title+"\"");
Expand All @@ -63,6 +104,12 @@ DynamicTest process_testcase(final TestCase testCase, final PublicKey publicKey,
Biscuit token = Biscuit.from_bytes(data, publicKey);
assertArrayEquals(token.serialize(), data);

List<org.biscuitsec.biscuit.token.Block> allBlocks = new ArrayList<>();
allBlocks.add(token.authority);
allBlocks.addAll(token.blocks);

compareBlocks(testCase.token, allBlocks);

List<RevocationIdentifier> revocationIds = token.revocation_identifiers();
JsonArray validationRevocationIds = validation.getAsJsonArray("revocation_ids");
assertEquals(revocationIds.size(), validationRevocationIds.size());
Expand Down
Loading