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

Merged feature/oauth2-authentication-module into feature/qrun-support-20250313

Browse Source
This commit is contained in:
darin.kelkhoff
2025-03-13 08:26:22 -05:00
parent 7d2282ebb7 a2b36a10e7
commit 5a5d98a3ff
17 changed files with 688 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
qqq-sample-project/src/main/java/com/kingsrook/sampleapp/SampleCli.java
View File

@ -50,7 +50,25 @@ public class SampleCli
{
try
{
QInstance qInstance = SampleMetaDataProvider.defineInstance();
QInstance qInstance = SampleMetaDataProvider.defineInstance();
return (run(qInstance, args));
}
catch(Exception e)
{
e.printStackTrace();
return (-1);
}
}
/***************************************************************************
**
***************************************************************************/
int run(QInstance qInstance, String[] args)
{
try
{
QPicoCliImplementation qPicoCliImplementation = new QPicoCliImplementation(qInstance);
return (qPicoCliImplementation.runCli("my-sample-cli", args));

3
qqq-sample-project/src/main/java/com/kingsrook/sampleapp/metadata/DynamicSiteProcessMetaDataProducer.java
View File

@ -50,8 +50,7 @@ public class DynamicSiteProcessMetaDataProducer extends MetaDataProducer<QProces
.withName(NAME)
.withStep(new QBackendStepMetaData()
.withName("DynamicSiteProcessStep")
.withCode(new QCodeReference(DynamicSiteProcessStep.class)))
);
.withCode(new QCodeReference(DynamicSiteProcessStep.class))));
}
}

63
qqq-sample-project/src/main/java/com/kingsrook/sampleapp/metadata/OAuth2MetaDataProvider.java Normal file
View File

@ -0,0 +1,63 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2022. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.kingsrook.sampleapp.metadata;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.instances.QMetaDataVariableInterpreter;
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerInterface;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.authentication.OAuth2AuthenticationMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.authentication.QAuthenticationMetaData;
/*******************************************************************************
** Provides all OAuth2 authentication related metadata to the QQQ engine
*
*******************************************************************************/
public class OAuth2MetaDataProvider implements MetaDataProducerInterface<QAuthenticationMetaData>
{
public static final String NAME = "OAuth2";
/***************************************************************************
**
***************************************************************************/
@Override
public QAuthenticationMetaData produce(QInstance qInstance) throws QException
{
QMetaDataVariableInterpreter qMetaDataVariableInterpreter = new QMetaDataVariableInterpreter();
String oauth2BaseUrl = qMetaDataVariableInterpreter.interpret("${env.OAUTH2_BASE_URL}");
String oauth2TokenUrl = qMetaDataVariableInterpreter.interpret("${env.OAUTH2_TOKEN_URL}");
String oauth2ClientId = qMetaDataVariableInterpreter.interpret("${env.OAUTH2_CLIENT_ID}");
String oauth2ClientSecret = qMetaDataVariableInterpreter.interpret("${env.OAUTH2_CLIENT_SECRET}");
return (new OAuth2AuthenticationMetaData()
.withBaseUrl(oauth2BaseUrl)
.withTokenUrl(oauth2TokenUrl)
.withClientId(oauth2ClientId)
.withClientSecret(oauth2ClientSecret)
.withName(NAME));
}
}

32
qqq-sample-project/src/main/java/com/kingsrook/sampleapp/metadata/SampleMetaDataProvider.java
View File

@ -41,6 +41,7 @@ import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepInpu
import com.kingsrook.qqq.backend.core.model.actions.processes.RunBackendStepOutput;
import com.kingsrook.qqq.backend.core.model.metadata.MetaDataProducerHelper;
import com.kingsrook.qqq.backend.core.model.metadata.QAuthenticationType;
import com.kingsrook.qqq.backend.core.model.metadata.QBackendMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.metadata.authentication.QAuthenticationMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.branding.QBrandingMetaData;
@ -71,6 +72,8 @@ import com.kingsrook.qqq.backend.core.model.metadata.tables.Association;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QFieldSection;
import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
import com.kingsrook.qqq.backend.core.model.metadata.tables.Tier;
import com.kingsrook.qqq.backend.core.modules.authentication.implementations.metadata.UserSessionMetaDataProducer;
import com.kingsrook.qqq.backend.core.modules.backend.implementations.memory.MemoryBackendModule;
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.ExtractViaQueryStep;
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.LoadViaInsertStep;
import com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.StreamedETLWithFrontendProcess;
@ -97,6 +100,7 @@ public class SampleMetaDataProvider extends AbstractQQQApplication
public static final String RDBMS_BACKEND_NAME = "rdbms";
public static final String FILESYSTEM_BACKEND_NAME = "filesystem";
public static final String MEMORY_BACKEND_NAME = "memory";
public static final String APP_NAME_GREETINGS = "greetingsApp";
public static final String APP_NAME_PEOPLE = "peopleApp";
@ -140,8 +144,8 @@ public class SampleMetaDataProvider extends AbstractQQQApplication
{
QInstance qInstance = new QInstance();
qInstance.setAuthentication(defineAuthentication());
qInstance.addBackend(defineRdbmsBackend());
qInstance.addBackend(defineMemoryBackend());
qInstance.addBackend(defineFilesystemBackend());
qInstance.addTable(defineTableCarrier());
qInstance.addTable(defineTablePerson());
@ -157,6 +161,8 @@ public class SampleMetaDataProvider extends AbstractQQQApplication
qInstance.addProcess(defineProcessScreenThenSleep());
qInstance.addProcess(defineProcessSimpleThrow());
qInstance.addTable(new UserSessionMetaDataProducer(MEMORY_BACKEND_NAME).produce(qInstance));
MetaDataProducerHelper.processAllMetaDataProducersInPackage(qInstance, SampleMetaDataProvider.class.getPackageName());
defineWidgets(qInstance);
@ -168,6 +174,30 @@ public class SampleMetaDataProvider extends AbstractQQQApplication
/***************************************************************************
** for tests, define the same instance as above, but use mock authentication.
***************************************************************************/
public static QInstance defineTestInstance() throws QException
{
QInstance qInstance = defineInstance();
qInstance.setAuthentication(defineAuthentication());
return qInstance;
}
/***************************************************************************
**
***************************************************************************/
private static QBackendMetaData defineMemoryBackend()
{
return new QBackendMetaData()
.withName(MEMORY_BACKEND_NAME)
.withBackendType(MemoryBackendModule.class);
}
/*******************************************************************************
**
*******************************************************************************/

11
qqq-sample-project/src/test/java/com/kingsrook/sampleapp/SampleCliTest.java
View File

@ -24,6 +24,7 @@ package com.kingsrook.sampleapp;
import com.kingsrook.qqq.backend.core.context.QContext;
import com.kingsrook.qqq.backend.core.exceptions.QException;
import com.kingsrook.qqq.backend.core.model.metadata.QInstance;
import com.kingsrook.qqq.backend.core.model.session.QSession;
import com.kingsrook.sampleapp.metadata.SampleMetaDataProvider;
import org.junit.jupiter.api.Test;
@ -43,8 +44,9 @@ class SampleCliTest
@Test
void testExitSuccess() throws QException
{
QContext.init(SampleMetaDataProvider.defineInstance(), new QSession());
int exitCode = new SampleCli().run(new String[] { "--meta-data" });
QInstance qInstance = SampleMetaDataProvider.defineTestInstance();
QContext.init(qInstance, new QSession());
int exitCode = new SampleCli().run(qInstance, new String[] { "--meta-data" });
assertEquals(0, exitCode);
}
@ -56,8 +58,9 @@ class SampleCliTest
@Test
void testNotExitSuccess() throws QException
{
QContext.init(SampleMetaDataProvider.defineInstance(), new QSession());
int exitCode = new SampleCli().run(new String[] { "asdfasdf" });
QInstance qInstance = SampleMetaDataProvider.defineTestInstance();
QContext.init(qInstance, new QSession());
int exitCode = new SampleCli().run(qInstance, new String[] { "asdfasdf" });
assertNotEquals(0, exitCode);
}

6
qqq-sample-project/src/test/java/com/kingsrook/sampleapp/SampleMetaDataProviderTest.java
View File

@ -75,7 +75,7 @@ public class SampleMetaDataProviderTest
void beforeEach() throws Exception
{
primeTestDatabase("prime-test-database.sql");
QContext.init(SampleMetaDataProvider.defineInstance(), new QSession());
QContext.init(SampleMetaDataProvider.defineTestInstance(), new QSession());
}
@ -190,7 +190,7 @@ public class SampleMetaDataProviderTest
@Test
public void testGreetProcess() throws Exception
{
QInstance qInstance = SampleMetaDataProvider.defineInstance();
QInstance qInstance = SampleMetaDataProvider.defineTestInstance();
QTableMetaData personTable = SampleMetaDataProvider.defineTablePerson();
RunProcessInput request = new RunProcessInput();
request.setProcessName(SampleMetaDataProvider.PROCESS_NAME_GREET);
@ -216,7 +216,7 @@ public class SampleMetaDataProviderTest
@Test
public void testThrowProcess() throws Exception
{
QInstance qInstance = SampleMetaDataProvider.defineInstance();
QInstance qInstance = SampleMetaDataProvider.defineTestInstance();
RunProcessInput request = new RunProcessInput();
request.setProcessName(SampleMetaDataProvider.PROCESS_NAME_SIMPLE_THROW);
request.addValue(SampleMetaDataProvider.ThrowerStep.FIELD_SLEEP_MILLIS, 10);

2
qqq-sample-project/src/test/java/com/kingsrook/sampleapp/dashboard/widgets/RenderAllWidgetsTest.java
View File

@ -47,7 +47,7 @@ class RenderAllWidgetsTest
@Test
void test() throws QException
{
QInstance qInstance = SampleMetaDataProvider.defineInstance();
QInstance qInstance = SampleMetaDataProvider.defineTestInstance();
QContext.init(qInstance, new QSession());
////////////////////////////////////////////////////////////////

2
qqq-sample-project/src/test/java/com/kingsrook/sampleapp/processes/clonepeople/ClonePeopleTransformStepTest.java
View File

@ -82,7 +82,7 @@ class ClonePeopleTransformStepTest
@Test
void testProcessStep() throws QException
{
QInstance qInstance = SampleMetaDataProvider.defineInstance();
QInstance qInstance = SampleMetaDataProvider.defineTestInstance();
QContext.init(qInstance, new QSession());
QueryInput queryInput = new QueryInput();