QRunIO/qqq
2
0
Fork 0
mirror of https://github.com/Kingsrook/qqq.git synced 2025-07-21 06:28:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Checkpoint: support for authentication; initial process tests

Browse Source
This commit is contained in:
Darin Kelkhoff
2022-02-15 18:20:00 -06:00
parent b33d99ce11
commit 200a0b7ccf
3 changed files with 302 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
src/test/java/com/kingsrook/qqq/frontend/picocli/QPicoCliImplementationTest.java
View File

@ -11,6 +11,7 @@ import java.io.IOException;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.HashMap;
import java.util.UUID;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.utils.JsonUtils;
@ -19,10 +20,12 @@ import org.apache.commons.io.FileUtils;
import org.json.JSONArray;
import org.json.JSONObject;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
/*******************************************************************************
@ -56,7 +59,7 @@ class QPicoCliImplementationTest
public void test_noArgs()
{
TestOutput testOutput = testCli();
assertTrue(testOutput.getOutput().contains("Usage: " + CLI_NAME));
assertTestOutputContains(testOutput, "Usage: " + CLI_NAME);
}
@ -69,8 +72,8 @@ class QPicoCliImplementationTest
public void test_help()
{
TestOutput testOutput = testCli("--help");
assertTrue(testOutput.getOutput().contains("Usage: " + CLI_NAME));
assertTrue(testOutput.getOutput().matches("(?s).*Commands:.*person.*"));
assertTestOutputContains(testOutput, "Usage: " + CLI_NAME);
assertTestOutputContains(testOutput, "Commands:.*person");
}
@ -83,7 +86,7 @@ class QPicoCliImplementationTest
public void test_version()
{
TestOutput testOutput = testCli("--version");
assertTrue(testOutput.getOutput().contains(CLI_NAME + " v1.0"));
assertTestOutputContains(testOutput, CLI_NAME + " v1.0");
}
@ -97,8 +100,8 @@ class QPicoCliImplementationTest
{
String badOption = "--asdf";
TestOutput testOutput = testCli(badOption);
assertTrue(testOutput.getError().contains("Unknown option: '" + badOption + "'"));
assertTrue(testOutput.getError().contains("Usage: " + CLI_NAME));
assertTestErrorContains(testOutput, "Unknown option: '" + badOption + "'");
assertTestErrorContains(testOutput, "Usage: " + CLI_NAME);
}
@ -131,8 +134,17 @@ class QPicoCliImplementationTest
public void test_table()
{
TestOutput testOutput = testCli("person");
assertTrue(testOutput.getOutput().contains("Usage: " + CLI_NAME + " person [COMMAND]"));
assertTrue(testOutput.getOutput().matches("(?s).*Commands:.*query.*"));
assertTestOutputContains(testOutput, "Usage: " + CLI_NAME + " person \\[COMMAND\\]");
assertTestOutputContains(testOutput, "Commands:.*query.*process");
///////////////////////////////////////////////////////
// make sure that if there are no processes for the //
// table, that the processes sub-command isn't given //
///////////////////////////////////////////////////////
QInstance qInstanceWithoutProcesses = TestUtils.defineInstance();
qInstanceWithoutProcesses.setProcesses(new HashMap<>());
testOutput = testCli(qInstanceWithoutProcesses, "person");
assertTestOutputDoesNotContain(testOutput, "process");
}
@ -146,8 +158,8 @@ class QPicoCliImplementationTest
{
String badCommand = "qwuijibo";
TestOutput testOutput = testCli("person", badCommand);
assertTrue(testOutput.getError().contains("Unmatched argument at index 1: '" + badCommand + "'"));
assertTrue(testOutput.getError().contains("Usage: " + CLI_NAME + " person [COMMAND]"));
assertTestErrorContains(testOutput, "Unmatched argument at index 1: '" + badCommand + "'");
assertTestErrorContains(testOutput, "Usage: " + CLI_NAME + " person \\[COMMAND\\]");
}
@ -202,7 +214,7 @@ class QPicoCliImplementationTest
public void test_tableInsertNoFieldsPrintsUsage()
{
TestOutput testOutput = testCli("person", "insert");
assertTrue(testOutput.getOutput().contains("Usage: " + CLI_NAME + " person insert"));
assertTestOutputContains(testOutput, "Usage: " + CLI_NAME + " person insert");
}
@ -299,7 +311,7 @@ class QPicoCliImplementationTest
String csvContents = """
"Louis","P","Willikers",1024,
"Nestle","G","Crunch",1701,
""";
File file = new File("/tmp/" + UUID.randomUUID() + ".csv");
@ -347,12 +359,111 @@ class QPicoCliImplementationTest
/*******************************************************************************
** test requesting the list of processes for a table
**
*******************************************************************************/
@Test
public void test_tableProcess() throws Exception
{
TestOutput testOutput = testCli("person", "process");
////////////////////////////////////////////////
// should list the processes under this table //
////////////////////////////////////////////////
assertTestOutputContains(testOutput, "Commands.*greet");
}
/*******************************************************************************
** test trying to run a process, but giving an invalid name.
**
*******************************************************************************/
@Test
public void test_tableProcessUnknownName() throws Exception
{
String badProcessName = "not-a-process";
TestOutput testOutput = testCli("person", "process", badProcessName);
assertTestErrorContains(testOutput, "Unmatched argument at index 2: '" + badProcessName + "'");
assertTestErrorContains(testOutput, "Usage: " + CLI_NAME + " person process \\[COMMAND\\]");
}
/*******************************************************************************
** test running a process on a table
**
*******************************************************************************/
@Test
@Disabled // not yet done.
public void test_tableProcessGreet() throws Exception
{
TestOutput testOutput = testCli("person", "process", "greet");
fail("Assertion not written...");
}
/*******************************************************************************
**
*******************************************************************************/
private void assertTestOutputContains(TestOutput testOutput, String expectedRegexSubstring)
{
if(!testOutput.getOutput().matches("(?s).*" + expectedRegexSubstring + ".*"))
{
fail("Expected output to contain this regex pattern:\n" + expectedRegexSubstring
+ "\nBut it did not. The full output was:\n" + testOutput.getOutput());
}
}
/*******************************************************************************
**
*******************************************************************************/
private void assertTestOutputDoesNotContain(TestOutput testOutput, String expectedRegexSubstring)
{
if(testOutput.getOutput().matches("(?s).*" + expectedRegexSubstring + ".*"))
{
fail("Expected output to not contain this regex pattern:\n" + expectedRegexSubstring
+ "\nBut it did. The full output was:\n" + testOutput.getOutput());
}
}
/*******************************************************************************
**
*******************************************************************************/
private void assertTestErrorContains(TestOutput testOutput, String expectedRegexSubstring)
{
if(!testOutput.getError().matches("(?s).*" + expectedRegexSubstring + ".*"))
{
fail("Expected error-output to contain this regex pattern:\n" + expectedRegexSubstring
+ "\nBut it did not. The full error-output was:\n" + testOutput.getOutput());
}
}
/*******************************************************************************
**
*******************************************************************************/
private TestOutput testCli(String... args)
{
QInstance qInstance = TestUtils.defineInstance();
return testCli(qInstance, args);
}
/*******************************************************************************
**
*******************************************************************************/
private TestOutput testCli(QInstance qInstance, String... args)
{
QPicoCliImplementation qPicoCliImplementation = new QPicoCliImplementation(qInstance);
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();

66
src/test/java/com/kingsrook/qqq/frontend/picocli/TestUtils.java
View File

@ -8,12 +8,23 @@ package com.kingsrook.qqq.frontend.picocli;
import java.io.InputStream;
import java.sql.Connection;
import java.util.List;
import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.QCodeReference;
import com.kingsrook.qqq.backend.core.model.metadata.QCodeType;
import com.kingsrook.qqq.backend.core.model.metadata.QCodeUsage;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.QFieldMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.QFieldType;
import com.kingsrook.qqq.backend.core.model.metadata.QTableMetaData;
import com.kingsrook.qqq.backend.module.rdbms.RDBSMBackendMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QFunctionInputMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QFunctionMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QFunctionOutputMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QOutputView;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QProcessMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QRecordListMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.processes.QRecordListView;
import com.kingsrook.qqq.backend.module.rdbms.RDBMSBackendMetaData;
import com.kingsrook.qqq.backend.module.rdbms.jdbc.ConnectionManager;
import com.kingsrook.qqq.backend.module.rdbms.jdbc.QueryManager;
import org.apache.commons.io.IOUtils;
@ -35,7 +46,7 @@ public class TestUtils
public static void primeTestDatabase() throws Exception
{
ConnectionManager connectionManager = new ConnectionManager();
Connection connection = connectionManager.getConnection(new RDBSMBackendMetaData(TestUtils.defineBackend()));
Connection connection = connectionManager.getConnection(new RDBMSBackendMetaData(TestUtils.defineBackend()));
InputStream primeTestDatabaseSqlStream = TestUtils.class.getResourceAsStream("/prime-test-database.sql");
assertNotNull(primeTestDatabaseSqlStream);
List<String> lines = (List<String>) IOUtils.readLines(primeTestDatabaseSqlStream);
@ -55,7 +66,7 @@ public class TestUtils
public static void runTestSql(String sql, QueryManager.ResultSetProcessor resultSetProcessor) throws Exception
{
ConnectionManager connectionManager = new ConnectionManager();
Connection connection = connectionManager.getConnection(new RDBSMBackendMetaData(defineBackend()));
Connection connection = connectionManager.getConnection(new RDBMSBackendMetaData(defineBackend()));
QueryManager.executeStatement(connection, sql, resultSetProcessor);
}
@ -68,13 +79,28 @@ public class TestUtils
public static QInstance defineInstance()
{
QInstance qInstance = new QInstance();
qInstance.setAuthentication(defineAuthentication());
qInstance.addBackend(defineBackend());
qInstance.addTable(defineTablePerson());
qInstance.addProcess(defineProcessGreetPeople());
return (qInstance);
}
/*******************************************************************************
** Define the authentication used in standard tests - using 'mock' type.
**
*******************************************************************************/
private static QAuthenticationMetaData defineAuthentication()
{
return new QAuthenticationMetaData()
.withName("mock")
.withType("mock");
}
/*******************************************************************************
** Define the h2 rdbms backend
**
@ -113,4 +139,38 @@ public class TestUtils
.withField(new QFieldMetaData("email", QFieldType.STRING));
}
/*******************************************************************************
** Define the 'greet people' process
*******************************************************************************/
private static QProcessMetaData defineProcessGreetPeople()
{
return new QProcessMetaData()
.withName("greet")
.withTableName("person")
.addFunction(new QFunctionMetaData()
.withName("prepare")
.withCode(new QCodeReference()
.withName("com.kingsrook.qqq.backend.core.interfaces.mock.MockFunctionBody")
.withCodeType(QCodeType.JAVA)
.withCodeUsage(QCodeUsage.FUNCTION)) // todo - needed, or implied in this context?
.withInputData(new QFunctionInputMetaData()
.withRecordListMetaData(new QRecordListMetaData().withTableName("person"))
.withFieldList(List.of(
new QFieldMetaData("greetingPrefix", QFieldType.STRING),
new QFieldMetaData("greetingSuffix", QFieldType.STRING)
)))
.withOutputMetaData(new QFunctionOutputMetaData()
.withRecordListMetaData(new QRecordListMetaData()
.withTableName("person")
.addField(new QFieldMetaData("fullGreeting", QFieldType.STRING))
)
.withFieldList(List.of(new QFieldMetaData("outputMessage", QFieldType.STRING))))
.withOutputView(new QOutputView()
.withMessageField("outputMessage")
.withRecordListView(new QRecordListView().withFieldNames(List.of("id", "firstName", "lastName", "fullGreeting"))))
);
}
}