productCategoryComboBox
+ Button abortButton
Button createProductButton
- Button abortButton
+ Registration createProductButtonRegistration
+ Label titleLabel
- CreateProductView(CreateProductViewModel createProductViewModel){
+ CreateProductView(CreateProductViewModel createProductViewModel, MaintainProductsController controller){
+ this.controller = controller
+ this.viewModel = createProductViewModel
- this.createProductViewModel = createProductViewModel
initTextFields()
initComboBoxes()
initButtons()
@@ -52,16 +58,16 @@ class CreateProductView extends HorizontalLayout{
}
private void initLayout(){
- Label label = new Label("Create Service Product")
- label.setStyleName(ValoTheme.LABEL_HUGE)
- this.addComponent(label)
+ titleLabel = new Label("Create Service Product")
+ titleLabel.setStyleName(ValoTheme.LABEL_HUGE)
+ this.addComponent(titleLabel)
//add textfields and boxes
HorizontalLayout sharedLayout = new HorizontalLayout(productUnitPriceField,productUnitComboBox)
sharedLayout.setWidthFull()
HorizontalLayout buttons = new HorizontalLayout(abortButton,createProductButton)
- VerticalLayout sideLayout = new VerticalLayout(label,productNameField,productDescriptionField,sharedLayout,productCategoryComboBox,buttons)
+ VerticalLayout sideLayout = new VerticalLayout(titleLabel,productNameField,productDescriptionField,sharedLayout,productCategoryComboBox,buttons)
sideLayout.setSizeFull()
sideLayout.setComponentAlignment(buttons, Alignment.BOTTOM_RIGHT)
@@ -113,29 +119,29 @@ class CreateProductView extends HorizontalLayout{
private void bindViewModel(){
//bind all textfields
- this.productNameField.addValueChangeListener({this.createProductViewModel.productName = it.value })
+ this.productNameField.addValueChangeListener({this.viewModel.productName = it.value })
- createProductViewModel.addPropertyChangeListener("productName", {
+ viewModel.addPropertyChangeListener("productName", {
String newValue = it.newValue as String
productNameField.value = newValue ?: productNameField.emptyValue
})
- this.productDescriptionField.addValueChangeListener({this.createProductViewModel.productDescription = it.value })
+ this.productDescriptionField.addValueChangeListener({this.viewModel.productDescription = it.value })
- createProductViewModel.addPropertyChangeListener("productDescription", {
+ viewModel.addPropertyChangeListener("productDescription", {
String newValue = it.newValue as String
productDescriptionField.value = newValue ?: productDescriptionField.emptyValue
})
- this.productUnitPriceField.addValueChangeListener({this.createProductViewModel.productUnitPrice = it.value})
+ this.productUnitPriceField.addValueChangeListener({this.viewModel.productUnitPrice = it.value})
- createProductViewModel.addPropertyChangeListener("productUnitPrice", {
+ viewModel.addPropertyChangeListener("productUnitPrice", {
String newValue = it.newValue as String
productUnitPriceField.value = newValue ?: productUnitPriceField.emptyValue
})
//bind combo boxes
- createProductViewModel.addPropertyChangeListener("productUnit", {
+ viewModel.addPropertyChangeListener("productUnit", {
ProductUnit newValue = it.newValue as ProductUnit
if (newValue) {
productUnitComboBox.value = newValue
@@ -144,10 +150,10 @@ class CreateProductView extends HorizontalLayout{
}
})
productUnitComboBox.addSelectionListener({
- createProductViewModel.setProductUnit(it.value as ProductUnit)
+ viewModel.setProductUnit(it.value as ProductUnit)
})
- createProductViewModel.addPropertyChangeListener("productCategory", {
+ viewModel.addPropertyChangeListener("productCategory", {
ProductCategory newValue = it.newValue as ProductCategory
if (newValue) {
productCategoryComboBox.value = newValue
@@ -156,14 +162,14 @@ class CreateProductView extends HorizontalLayout{
}
})
productCategoryComboBox.addSelectionListener({
- createProductViewModel.setProductCategory(it.value as ProductCategory)
+ viewModel.setProductCategory(it.value as ProductCategory)
})
/*
We listen to the valid properties. whenever the presenter resets values in the viewmodel
and resets the valid properties the component error on the respective component is removed
*/
- createProductViewModel.addPropertyChangeListener({
+ viewModel.addPropertyChangeListener({
switch (it.propertyName) {
case "productNameValid":
if (it.newValue || it.newValue == null) {
@@ -210,51 +216,51 @@ class CreateProductView extends HorizontalLayout{
this.productNameField.addValueChangeListener({ event ->
ValidationResult result = nameValidator.apply(event.getValue(), new ValueContext(this.productNameField))
if (result.isError()) {
- createProductViewModel.productNameValid = false
+ viewModel.productNameValid = false
UserError error = new UserError(result.getErrorMessage())
productNameField.setComponentError(error)
} else {
- createProductViewModel.productNameValid = true
+ viewModel.productNameValid = true
}
})
this.productDescriptionField.addValueChangeListener({ event ->
ValidationResult result = nameValidator.apply(event.getValue(), new ValueContext(this.productDescriptionField))
if (result.isError()) {
- createProductViewModel.productDescriptionValid = false
+ viewModel.productDescriptionValid = false
UserError error = new UserError(result.getErrorMessage())
productDescriptionField.setComponentError(error)
} else {
- createProductViewModel.productDescriptionValid = true
+ viewModel.productDescriptionValid = true
}
})
this.productUnitPriceField.addValueChangeListener({ event ->
ValidationResult result = numberValidator.apply(event.getValue(), new ValueContext(this.productUnitPriceField))
if (result.isError()) {
- createProductViewModel.productUnitPriceValid = false
+ viewModel.productUnitPriceValid = false
UserError error = new UserError(result.getErrorMessage())
productUnitPriceField.setComponentError(error)
} else {
- createProductViewModel.productUnitPriceValid = true
+ viewModel.productUnitPriceValid = true
}
})
this.productUnitComboBox.addSelectionListener({selection ->
ValidationResult result = selectionValidator.apply(selection.getValue(), new ValueContext(this.productUnitComboBox))
if (result.isError()) {
- createProductViewModel.productUnitValid = false
+ viewModel.productUnitValid = false
UserError error = new UserError(result.getErrorMessage())
productUnitComboBox.setComponentError(error)
} else {
- createProductViewModel.productUnitValid = true
+ viewModel.productUnitValid = true
}
})
this.productCategoryComboBox.addSelectionListener({ selection ->
ValidationResult result = selectionValidator.apply(selection.getValue(), new ValueContext(this.productCategoryComboBox))
if (result.isError()) {
- createProductViewModel.productCategoryValid = false
+ viewModel.productCategoryValid = false
UserError error = new UserError(result.getErrorMessage())
productCategoryComboBox.setComponentError(error)
} else {
- createProductViewModel.productCategoryValid = true
+ viewModel.productCategoryValid = true
}
})
}
@@ -263,22 +269,27 @@ class CreateProductView extends HorizontalLayout{
* It relies on the separate fields for validation.
* @return
*/
- private boolean allValuesValid() {
- return createProductViewModel.productNameValid \
- && createProductViewModel.productDescriptionValid \
- && createProductViewModel.productUnitValid \
- && createProductViewModel.productUnitPriceValid \
- && createProductViewModel.productCategoryValid
+ protected boolean allValuesValid() {
+ return viewModel.productNameValid \
+ && viewModel.productDescriptionValid \
+ && viewModel.productUnitValid \
+ && viewModel.productUnitPriceValid \
+ && viewModel.productCategoryValid
}
private void setupListeners(){
- abortButton.addClickListener({ clearAllFields() })
+
+ abortButton.addClickListener({clearAllFields() })
+ createProductButtonRegistration = this.createProductButton.addClickListener({
+ controller.createNewProduct(viewModel.productCategory, viewModel.productDescription,viewModel.productName, Double.parseDouble(viewModel.productUnitPrice),viewModel.productUnit)
+ })
+
}
/**
* Clears User Input from all fields in the Create Products View and reset validation status of all Fields
*/
- private void clearAllFields() {
+ protected void clearAllFields() {
productNameField.clear()
productDescriptionField.clear()
@@ -286,11 +297,11 @@ class CreateProductView extends HorizontalLayout{
productCategoryComboBox.selectedItem = productCategoryComboBox.clear()
productUnitComboBox.selectedItem = productUnitComboBox.clear()
- createProductViewModel.productNameValid = null
- createProductViewModel.productDescriptionValid = null
- createProductViewModel.productUnitPriceValid = null
- createProductViewModel.productCategoryValid = null
- createProductViewModel.productUnitValid = null
+ viewModel.productNameValid = null
+ viewModel.productDescriptionValid = null
+ viewModel.productUnitPriceValid = null
+ viewModel.productCategoryValid = null
+ viewModel.productUnitValid = null
}
}
diff --git a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/components/products/MaintainProductsView.groovy b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/components/products/MaintainProductsView.groovy
deleted file mode 100644
index 00dd3000b..000000000
--- a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/components/products/MaintainProductsView.groovy
+++ /dev/null
@@ -1,24 +0,0 @@
-package life.qbic.portal.offermanager.components.products
-
-import com.vaadin.ui.FormLayout
-
-/**
- *
- * This class generates a Form Layout in which the user can maintain the service products
- *
- * {@link MaintainProductsViewModel} will be integrated into the qOffer 2.0 Portlet and provides an User Interface
- * with the intention of enabling an {@value life.qbic.portal.offermanager.security.Role#OFFER_ADMIN} to create, archive and copy products.
- *
- * @since 1.0.0
- *
- */
-class MaintainProductsView extends FormLayout{
-
- private final MaintainProductsController controller
- private final MaintainProductsViewModel viewModel
-
- MaintainProductsView(MaintainProductsController controller, MaintainProductsViewModel viewModel){
- this.controller = controller
- this.viewModel = viewModel
- }
-}
diff --git a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/components/products/MaintainProductsViewModel.groovy b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/components/products/MaintainProductsViewModel.groovy
deleted file mode 100644
index fd77fce31..000000000
--- a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/components/products/MaintainProductsViewModel.groovy
+++ /dev/null
@@ -1,41 +0,0 @@
-package life.qbic.portal.offermanager.components.products
-
-import life.qbic.datamodel.dtos.business.services.Product
-import life.qbic.portal.offermanager.dataresources.products.ProductsResourcesService
-
-
-/**
- * A ViewModel holding data that is presented in a
- * {@link life.qbic.portal.offermanager.components.products.MaintainProductsView}
- *
- * This class holds all specific fields that are mutable in the view
- * Whenever values change it should be reflected in the corresponding view. This class can be used
- * for UI unit testing purposes.
- *
- * This class can contain JavaBean objects to enable views to listen to changes in the values.
- *
- * @since 1.0.0
- *
- */
-class MaintainProductsViewModel {
-
- ObservableList products = new ObservableList(new ArrayList())
-
- private final ProductsResourcesService productsResourcesService
-
- MaintainProductsViewModel(ProductsResourcesService productsResourcesService) {
- this.productsResourcesService = productsResourcesService
- fetchProducts()
- subscribe()
- }
-
- private void fetchProducts(){
- products.addAll(productsResourcesService.iterator())
- }
-
- private void subscribe(){
- productsResourcesService.subscribe({ product ->
- products << product
- })
- }
-}
diff --git a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OfferDbConnector.groovy b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OfferDbConnector.groovy
index 3862f478a..9ebab4cb6 100644
--- a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OfferDbConnector.groovy
+++ b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OfferDbConnector.groovy
@@ -7,6 +7,9 @@ import life.qbic.datamodel.dtos.business.Customer
import life.qbic.datamodel.dtos.business.Offer
import life.qbic.business.exceptions.DatabaseQueryException
import life.qbic.business.offers.create.CreateOfferDataSource
+import life.qbic.datamodel.dtos.projectmanagement.ProjectCode
+import life.qbic.datamodel.dtos.projectmanagement.ProjectIdentifier
+import life.qbic.datamodel.dtos.projectmanagement.ProjectSpace
import life.qbic.portal.offermanager.dataresources.persons.PersonDbConnector
import life.qbic.portal.offermanager.dataresources.database.ConnectionProvider
import life.qbic.portal.offermanager.dataresources.products.ProductsDbConnector
@@ -24,14 +27,13 @@ import java.sql.*
*
*/
@Log4j2
-class OfferDbConnector implements CreateOfferDataSource, FetchOfferDataSource{
+class OfferDbConnector implements CreateOfferDataSource, FetchOfferDataSource, ProjectAssistant{
ConnectionProvider connectionProvider
PersonDbConnector customerGateway
ProductsDbConnector productGateway
-
private static final String OFFER_INSERT_QUERY = "INSERT INTO offer (offerId, " +
"creationDate, expirationDate, customerId, projectManagerId, projectTitle, " +
"projectObjective, totalPrice, customerAffiliationId, vat, netPrice, overheads, " +
@@ -184,7 +186,7 @@ class OfferDbConnector implements CreateOfferDataSource, FetchOfferDataSource{
List offerOverviewList = []
String query = "SELECT offerId, creationDate, projectTitle, " +
- "totalPrice, first_name, last_name, email\n" +
+ "totalPrice, first_name, last_name, email, associatedProject\n" +
"FROM offer \n" +
"LEFT JOIN person \n" +
"ON offer.customerId = person.id"
@@ -204,9 +206,19 @@ class OfferDbConnector implements CreateOfferDataSource, FetchOfferDataSource{
def creationDate = resultSet.getDate("creationDate")
def customerName = "${customer.getFirstName()} ${customer.getLastName()}"
def offerId = parseOfferId(resultSet.getString("offerId"))
- OfferOverview offerOverview = new OfferOverview(offerId,
- creationDate,projectTitle, "-",
- customerName, totalCosts)
+ Optional projectIdentifier = parseProjectIdentifier(
+ resultSet.getString("associatedProject"))
+
+ OfferOverview offerOverview
+ if (projectIdentifier.isPresent()) {
+ offerOverview = new OfferOverview(offerId,
+ creationDate,projectTitle,
+ customerName, totalCosts, projectIdentifier.get())
+ } else {
+ offerOverview = new OfferOverview(offerId,
+ creationDate,projectTitle, "",
+ customerName, totalCosts)
+ }
offerOverviewList.add(offerOverview)
}
}
@@ -263,8 +275,9 @@ class OfferDbConnector implements CreateOfferDataSource, FetchOfferDataSource{
def selectedAffiliation = customerGateway.getAffiliation(selectedAffiliationId)
def items = productGateway.getItemsForOffer(offerPrimaryId)
def checksum = resultSet.getString("checksum")
+ def associatedProject = resultSet.getString("associatedProject")
- offer = Optional.of(new Offer.Builder(
+ def offerBuilder = new Offer.Builder(
customer,
projectManager,
projectTitle,
@@ -279,9 +292,46 @@ class OfferDbConnector implements CreateOfferDataSource, FetchOfferDataSource{
.overheads(overheads)
.netPrice(net)
.checksum(checksum)
- .build())
+ Optional projectIdentifier = parseProjectIdentifier(associatedProject)
+ if (projectIdentifier.isPresent()) {
+ offerBuilder.associatedProject(projectIdentifier.get())
+ }
+ offer = Optional.of(offerBuilder.build())
}
}
return offer
}
+
+ private static Optional parseProjectIdentifier(String projectIdentifier) {
+ Optional identifier = Optional.empty()
+ if (!projectIdentifier) {
+ return identifier
+ }
+ try {
+ def splittedIdentifier = projectIdentifier.split("/")
+ def space = new ProjectSpace(splittedIdentifier[0])
+ def code = new ProjectCode(splittedIdentifier[1])
+ identifier = Optional.of(new ProjectIdentifier(space, code))
+ } catch (Exception e) {
+ log.error(e.message)
+ log.error(e.stackTrace.join("\n"))
+ }
+ return identifier
+ }
+
+ /**
+ * {@inheritDocs}
+ */
+ @Override
+ void linkOfferWithProject(OfferId offerId, ProjectIdentifier projectIdentifier) {
+ String query = "UPDATE offer SET associatedProject = ? WHERE offerId = ?"
+
+ Connection connection = connectionProvider.connect()
+ connection.withCloseable {
+ PreparedStatement statement = it.prepareStatement(query)
+ statement.setString(1, projectIdentifier.toString())
+ statement.setString(2, offerId.toString())
+ statement.executeUpdate()
+ }
+ }
}
diff --git a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OfferOverview.groovy b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OfferOverview.groovy
index 98ca7aa27..051977c04 100644
--- a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OfferOverview.groovy
+++ b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OfferOverview.groovy
@@ -1,6 +1,8 @@
package life.qbic.portal.offermanager.dataresources.offers
+import groovy.transform.EqualsAndHashCode
import life.qbic.datamodel.dtos.business.OfferId
+import life.qbic.datamodel.dtos.projectmanagement.ProjectIdentifier
/**
* This class holds data for an offer overview
@@ -11,10 +13,15 @@ import life.qbic.datamodel.dtos.business.OfferId
*
* @since 1.0.0
*/
+@EqualsAndHashCode
class OfferOverview {
final String projectTitle
+ /**
+ * @deprecated Use the {@link #associatedProject} property to link an offer with a project
+ */
+ @Deprecated
final String projectId
final String customer
@@ -25,6 +32,9 @@ class OfferOverview {
final OfferId offerId
+ final Optional associatedProject
+
+ @Deprecated
OfferOverview(
OfferId offerId,
Date modificationDate,
@@ -38,5 +48,22 @@ class OfferOverview {
this.projectTitle = projectTitle
this.customer = customer
this.totalPrice = totalPrice
+ this.associatedProject = Optional.empty()
+ }
+
+ OfferOverview(
+ OfferId offerId,
+ Date modificationDate,
+ String projectTitle,
+ String customer,
+ double totalPrice,
+ ProjectIdentifier associatedProject) {
+ this.offerId = offerId
+ this.modificationDate = modificationDate
+ this.projectId = ""
+ this.projectTitle = projectTitle
+ this.customer = customer
+ this.totalPrice = totalPrice
+ this.associatedProject = Optional.of(associatedProject)
}
}
diff --git a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OverviewService.groovy b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OverviewService.groovy
index ce9021f11..0e1bec3c1 100644
--- a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OverviewService.groovy
+++ b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/OverviewService.groovy
@@ -1,6 +1,7 @@
package life.qbic.portal.offermanager.dataresources.offers
import life.qbic.datamodel.dtos.business.Offer
+import life.qbic.datamodel.dtos.projectmanagement.Project
import life.qbic.portal.offermanager.communication.EventEmitter
import life.qbic.portal.offermanager.communication.Subscription
import life.qbic.portal.offermanager.dataresources.ResourcesService
@@ -24,13 +25,40 @@ class OverviewService implements ResourcesService {
private final EventEmitter updatedOverviewEvent
+ private final EventEmitter projectCreatedEvent
+
OverviewService(OfferDbConnector offerDbConnector,
- OfferResourcesService offerService) {
+ OfferResourcesService offerService,
+ EventEmitter projectCreatedEvent) {
this.offerDbConnector = offerDbConnector
this.updatedOverviewEvent = new EventEmitter<>()
this.offerService = offerService
+ this.projectCreatedEvent = projectCreatedEvent
this.offerOverviewList = offerDbConnector.loadOfferOverview()
subscribeToNewOffers()
+ subscribeToNewProjects()
+ }
+
+ private void subscribeToNewProjects() {
+ /*
+ Whenever a new project is created, we want to update the associated
+ offer overview with the project identifier detail
+ */
+ projectCreatedEvent.register({ Project project ->
+ OfferOverview affectedOffer = offerOverviewList.find{
+ it.offerId.equals(project.linkedOffer)}
+ if (affectedOffer) {
+ offerOverviewList.remove(affectedOffer)
+ OfferOverview updatedOverview = new OfferOverview(
+ affectedOffer.offerId,
+ affectedOffer.modificationDate,
+ affectedOffer.projectTitle,
+ affectedOffer.customer.toString(),
+ affectedOffer.totalPrice,
+ project.projectId)
+ this.addToResource(updatedOverview)
+ }
+ })
}
private void subscribeToNewOffers(){
diff --git a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/ProjectAssistant.groovy b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/ProjectAssistant.groovy
new file mode 100644
index 000000000..8a9cf068b
--- /dev/null
+++ b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/offers/ProjectAssistant.groovy
@@ -0,0 +1,23 @@
+package life.qbic.portal.offermanager.dataresources.offers
+
+import life.qbic.business.exceptions.DatabaseQueryException
+import life.qbic.datamodel.dtos.business.OfferId
+import life.qbic.datamodel.dtos.projectmanagement.ProjectIdentifier
+
+/**
+ * Small helper interface that provides linking functionality of offers and projects
+ *
+ * @since 1.0.0
+ */
+interface ProjectAssistant {
+
+ /**
+ * Link an offer with an associated project id.
+ * @param offerId The offer you want to link to the project
+ * @param projectIdentifier The project you want to have the offer linked to
+ * @throws DatabaseQueryException if the update of the offer entry cannot be performed
+ */
+ void linkOfferWithProject(OfferId offerId, ProjectIdentifier projectIdentifier)
+ throws DatabaseQueryException
+
+}
diff --git a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/products/ProductsDbConnector.groovy b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/products/ProductsDbConnector.groovy
index 8e0534e50..ae8b4f29f 100644
--- a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/products/ProductsDbConnector.groovy
+++ b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/products/ProductsDbConnector.groovy
@@ -2,14 +2,17 @@ package life.qbic.portal.offermanager.dataresources.products
import groovy.sql.GroovyRowResult
import groovy.util.logging.Log4j2
+import life.qbic.business.exceptions.DatabaseQueryException
+import life.qbic.business.products.Converter
import life.qbic.business.products.archive.ArchiveProductDataSource
+import life.qbic.business.products.copy.CopyProductDataSource
import life.qbic.business.products.create.CreateProductDataSource
import life.qbic.business.products.create.ProductExistsException
+import life.qbic.datamodel.dtos.business.ProductCategory
+import life.qbic.datamodel.dtos.business.ProductCategoryFactory
import life.qbic.datamodel.dtos.business.ProductId
import life.qbic.datamodel.dtos.business.ProductItem
import life.qbic.datamodel.dtos.business.services.*
-import life.qbic.business.exceptions.DatabaseQueryException
-
import life.qbic.portal.offermanager.dataresources.database.ConnectionProvider
import org.apache.groovy.sql.extensions.SqlExtensions
@@ -24,10 +27,13 @@ import java.sql.SQLException
* @since 1.0.0
*/
@Log4j2
-class ProductsDbConnector implements ArchiveProductDataSource, CreateProductDataSource {
+class ProductsDbConnector implements ArchiveProductDataSource, CreateProductDataSource, CopyProductDataSource {
private final ConnectionProvider provider
+ private static final ProductCategoryFactory productCategoryFactory = new ProductCategoryFactory()
+ private static final ProductUnitFactory productUnitFactory = new ProductUnitFactory()
+
/**
* Creates a connector for a MariaDB instance.
*
@@ -55,77 +61,75 @@ class ProductsDbConnector implements ArchiveProductDataSource, CreateProductData
try {
return fetchAllProductsFromDb()
} catch (SQLException e) {
- log.error(e.message)
- log.error(e.stackTrace.join("\n"))
+ log.error("Unexpected exception: $e.message")
+ log.debug("Unexpected exception: $e.message", e)
throw new DatabaseQueryException("Unable to list all available products.")
}
}
private List fetchAllProductsFromDb() {
- List products = []
+ List products = new ArrayList<>()
+ String query = Queries.SELECT_ALL_PRODUCTS + "WHERE active = 1"
provider.connect().withCloseable {
- final PreparedStatement query = it.prepareStatement(Queries.SELECT_ALL_PRODUCTS)
- final ResultSet resultSet = query.executeQuery()
+ final PreparedStatement statement = it.prepareStatement(query)
+ final ResultSet resultSet = statement.executeQuery()
products.addAll(convertResultSet(resultSet))
}
return products
}
private static List convertResultSet(ResultSet resultSet) {
- final def products = []
+ final List products = new ArrayList<>()
while (resultSet.next()) {
- products.add(rowResultToProduct(SqlExtensions.toRowResult(resultSet)))
+ try {
+ Product product = rowResultToProduct(SqlExtensions.toRowResult(resultSet))
+ products.add(product)
+ } catch (IllegalArgumentException illegalRow) {
+ log.warn("Could not parse row. Skipping")
+ log.debug("Could not parse row. Skipping.", illegalRow)
+ }
}
return products
}
- private static Product rowResultToProduct(GroovyRowResult row) {
- def productCategory = row.category
- String productId = row.productId
+ /**
+ *
+ * @param row a GroovyRowResult map
+ * @return a Product parsed from the provided map
+ * @throws IllegalArgumentException in case not all fields necessary are found
+ * or fields could not be parsed
+ */
+ private static Product rowResultToProduct(GroovyRowResult row) throws IllegalArgumentException {
Product product
- switch(productCategory) {
- case "Data Storage":
- product = new DataStorage(row.productName as String,
- row.description as String,
- row.unitPrice as Double,
- new ProductUnitFactory().getForString(row.unit as String), parseProductId(productId))
- break
- case "Primary Bioinformatics":
- product = new PrimaryAnalysis(row.productName as String,
- row.description as String,
- row.unitPrice as Double,
- new ProductUnitFactory().getForString(row.unit as String), parseProductId(productId))
- break
- case "Project Management":
- product = new ProjectManagement(row.productName as String,
- row.description as String,
- row.unitPrice as Double,
- new ProductUnitFactory().getForString(row.unit as String), parseProductId(productId))
- break
- case "Secondary Bioinformatics":
- product = new SecondaryAnalysis(row.productName as String,
- row.description as String,
- row.unitPrice as Double,
- new ProductUnitFactory().getForString(row.unit as String), parseProductId(productId))
- break
- case "Sequencing":
- product = new Sequencing(row.productName as String,
- row.description as String,
- row.unitPrice as Double,
- new ProductUnitFactory().getForString(row.unit as String), parseProductId(productId))
- break
- }
- if(product == null) {
- log.error("Product could not be parsed from database query.")
- log.error(row)
- throw new DatabaseQueryException("Cannot parse product")
- } else {
- return product
+ try {
+ String description = row.description
+ ProductCategory productCategory = productCategoryFactory.getForString(row.category as String)
+ long productId = parseProductId(row.productId as String)
+ String productName = row.productName
+ ProductUnit productUnit = productUnitFactory.getForString(row.unit as String)
+ double unitPrice = row.unitPrice
+
+ product = Converter.createProductWithVersion(
+ productCategory,
+ productName,
+ description,
+ unitPrice,
+ productUnit,
+ productId)
+
+ } catch (NullPointerException | IllegalArgumentException illegalArgument) {
+ throw new IllegalArgumentException("Could not parse product from provided information.", illegalArgument)
}
+ return product
}
- def createOfferItems(List items, int offerId) {
-
+ /**
+ * This method associates an offer with product items.
+ *
+ * @param items A list of product items of an offer
+ * @param offerId An offerId which references the offer containing the list of product items
+ */
+ void createOfferItems(List items, int offerId) {
items.each {productItem ->
String query = "INSERT INTO productitem (productId, quantity, offerid) "+
"VALUE(?,?,?)"
@@ -176,13 +180,16 @@ class ProductsDbConnector implements ArchiveProductDataSource, CreateProductData
* Returns the product identifying running number given a productId
*
* @param productId String of productId stored in the DB e.g. "DS_1"
- * @return identifier String of the iterative identifying part of the productId
+ * @return identifier Long of the iterative identifying part of the productId
*/
- static String parseProductId(String productId) {
+ private static long parseProductId(String productId) throws NumberFormatException{
+ if (!productId.contains("_")) {
+ throw new IllegalArgumentException("Not a valid product identifier.")
+ }
def splitId = productId.split("_")
// The first entry [0] contains the product type which is assigned automatically, no need to parse it.
String identifier = splitId[1]
- return identifier
+ return Long.parseLong(identifier)
}
@@ -192,12 +199,14 @@ class ProductsDbConnector implements ArchiveProductDataSource, CreateProductData
* @param product A product for which the type needs to be determined
* @return the type of the product or null
*/
- static String getProductType(Product product){
- if (product instanceof Sequencing) return 'Sequencing'
- if (product instanceof ProjectManagement) return 'Project Management'
- if (product instanceof PrimaryAnalysis) return 'Primary Bioinformatics'
- if (product instanceof SecondaryAnalysis) return 'Secondary Bioinformatics'
- if (product instanceof DataStorage) return 'Data Storage'
+ private static String getProductType(Product product){
+ if (product instanceof Sequencing) return ProductCategory.SEQUENCING.getValue()
+ if (product instanceof ProjectManagement) return ProductCategory.PROJECT_MANAGEMENT.getValue()
+ if (product instanceof PrimaryAnalysis) return ProductCategory.PRIMARY_BIOINFO.getValue()
+ if (product instanceof SecondaryAnalysis) return ProductCategory.SECONDARY_BIOINFO.getValue()
+ if (product instanceof DataStorage) return ProductCategory.DATA_STORAGE.getValue()
+ if (product instanceof ProteomicAnalysis) return ProductCategory.PROTEOMIC.getValue()
+ if (product instanceof MetabolomicAnalysis) return ProductCategory.METABOLOMIC.getValue()
return null
}
@@ -215,10 +224,15 @@ class ProductsDbConnector implements ArchiveProductDataSource, CreateProductData
statement.setInt(1, offerPrimaryId)
ResultSet result = statement.executeQuery()
while (result.next()) {
- Product product = rowResultToProduct(SqlExtensions.toRowResult(result))
- double quantity = result.getDouble("quantity")
- ProductItem item = new ProductItem(quantity, product)
- productItems << item
+ try {
+ Product product = rowResultToProduct(SqlExtensions.toRowResult(result))
+ double quantity = result.getDouble("quantity")
+ ProductItem item = new ProductItem(quantity, product)
+ productItems << item
+ } catch (IllegalArgumentException illegalArgumentException) {
+ log.warn("Could not parse product. Skipping.")
+ log.debug("Could not parse product. Skipping.", illegalArgumentException)
+ }
}
}
return productItems
@@ -251,32 +265,36 @@ class ProductsDbConnector implements ArchiveProductDataSource, CreateProductData
@Override
Optional fetch(ProductId productId) throws DatabaseQueryException {
Connection connection = provider.connect()
- String query = Queries.SELECT_ALL_PRODUCTS + " WHERE productId=?"
+ String query = Queries.SELECT_ALL_PRODUCTS + "WHERE active = 1 AND productId=?"
Optional product = Optional.empty()
connection.withCloseable {
PreparedStatement preparedStatement = it.prepareStatement(query)
- preparedStatement.setString(1, productId.identifier.toString())
+ preparedStatement.setString(1, productId.toString())
ResultSet result = preparedStatement.executeQuery()
while (result.next()) {
- product = Optional.of(rowResultToProduct(SqlExtensions.toRowResult(result)))
+ try {
+ product = Optional.of(rowResultToProduct(SqlExtensions.toRowResult(result)))
+ } catch(IllegalArgumentException illegalArgumentException) {
+ log.warn("Could not parse product. Skipping.")
+ log.debug("Could not parse product. Skipping.", illegalArgumentException)
+ }
}
}
return product
}
/**
- * Stores a product in the database
- * @param product The product that needs to be stored
- * @since 1.0.0
- * @throws DatabaseQueryException if any technical interaction with the data source fails
- * @throws ProductExistsException if the product already exists in the data source
+ *
+ * {@inheritDoc}
*/
@Override
- void store(Product product) throws DatabaseQueryException, ProductExistsException {
+ ProductId store(Product product) throws DatabaseQueryException, ProductExistsException {
Connection connection = provider.connect()
+ ProductId productId = createProductId(product)
+
connection.withCloseable {
PreparedStatement preparedStatement = it.prepareStatement(Queries.INSERT_PRODUCT)
preparedStatement.setString(1, getProductType(product))
@@ -284,10 +302,42 @@ class ProductsDbConnector implements ArchiveProductDataSource, CreateProductData
preparedStatement.setString(3, product.productName)
preparedStatement.setDouble(4, product.unitPrice)
preparedStatement.setString(5, product.unit.value)
- preparedStatement.setString(6, product.productId.toString())
+ preparedStatement.setString(6, productId.toString())
preparedStatement.execute()
}
+
+ return productId
+ }
+
+ private ProductId createProductId(Product product){
+ String productType = product.productId.type
+ String version = fetchLatestIdentifier(productType) //todo exchange with long
+
+ return new ProductId(productType,version)
+ }
+
+ private Long fetchLatestIdentifier(String productType){
+ String query = "SELECT MAX(productId) FROM product WHERE productId LIKE ?"
+ Connection connection = provider.connect()
+
+ String category = productType + "_%"
+ Long latestUniqueId = 0
+
+ connection.withCloseable {
+ PreparedStatement preparedStatement = it.prepareStatement(query)
+ preparedStatement.setString(1, category)
+
+ ResultSet result = preparedStatement.executeQuery()
+
+ while(result.next()){
+ String id = result.getString(1)
+
+ if(id) latestUniqueId = Long.parseLong(id.split('_')[1])
+ }
+ }
+
+ return latestUniqueId + 1
}
/**
@@ -308,7 +358,7 @@ class ProductsDbConnector implements ArchiveProductDataSource, CreateProductData
/**
* Query for all available products.
*/
- final static String SELECT_ALL_PRODUCTS = "SELECT * FROM product"
+ final static String SELECT_ALL_PRODUCTS = "SELECT * FROM product "
/**
* Query for all items of an offer.
diff --git a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/projects/ProjectDbConnector.groovy b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/projects/ProjectDbConnector.groovy
index ec4658ee6..5a56a6829 100644
--- a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/projects/ProjectDbConnector.groovy
+++ b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/projects/ProjectDbConnector.groovy
@@ -1,7 +1,8 @@
package life.qbic.portal.offermanager.dataresources.projects
+import groovy.transform.CompileStatic
import groovy.util.logging.Log4j2
-import life.qbic.datamodel.dtos.general.Person
+
import life.qbic.portal.offermanager.dataresources.persons.PersonDbConnector
import life.qbic.datamodel.dtos.business.*
@@ -9,6 +10,7 @@ import life.qbic.datamodel.dtos.projectmanagement.*
import life.qbic.business.projects.create.ProjectExistsException
import life.qbic.business.exceptions.DatabaseQueryException
import life.qbic.portal.offermanager.dataresources.database.ConnectionProvider
+
import java.sql.Connection
import java.sql.PreparedStatement
import java.sql.ResultSet
@@ -25,166 +27,162 @@ import java.sql.Statement
@Log4j2
class ProjectDbConnector {
- /**
+ /**
* A connection to the project/customer database used to create queries.
*/
private final ConnectionProvider connectionProvider
- /**
+ /**
* A connector to the customer database used to create queries.
*/
private final PersonDbConnector personDbConnector
- /**
+ /**
* Constructor for a ProjectDbConnector
* @param connectionProvider a connection provider to the project/customer db
* @param personDbConnector db connector used to connect projects to customer and manager
*
*/
ProjectDbConnector(ConnectionProvider connectionProvider, PersonDbConnector personDbConnector) {
- this.connectionProvider = connectionProvider
- this.personDbConnector = personDbConnector
+ this.connectionProvider = connectionProvider
+ this.personDbConnector = personDbConnector
}
- /**
+ /**
* parses existing projects from user database, might be needed later if more complex information is to be listed
*/
- public List fetchProjects() {
- List projects = []
- String query = "SELECT openbis_project_identifier from projects"
- Connection connection = connectionProvider.connect()
- connection.withCloseable {
- def preparedStatement = it.prepareStatement(query)
- ResultSet resultSet = preparedStatement.executeQuery()
- while(resultSet.next()) {
- try {
- String[] tokens = resultSet.getString('openbis_project_identifier').split("/")
- ProjectSpace space = tokens[1]
- ProjectCode project = tokens[2]
- } catch (Exception e) {
- e.printStackTrace()
- throw new DatabaseQueryException("Could not parse existing projects from database.")
- }
- projects.add(new ProjectIdentifier(space, project))
+ List fetchProjects() {
+ List projects = []
+ String query = "SELECT openbis_project_identifier from projects"
+ Connection connection = connectionProvider.connect()
+ connection.withCloseable {
+ def preparedStatement = it.prepareStatement(query)
+ ResultSet resultSet = preparedStatement.executeQuery()
+ while(resultSet.next()) {
+ try {
+ String[] tokens = resultSet.getString('openbis_project_identifier').split("/")
+ ProjectSpace space = new ProjectSpace(tokens[1])
+ ProjectCode project = new ProjectCode(tokens[2])
+ projects.add(new ProjectIdentifier(space, project))
+ } catch (Exception e) {
+ e.printStackTrace()
+ throw new DatabaseQueryException("Could not parse existing projects from database.")
+ }
+ }
}
- }
- return projects
+ return projects
}
- /**
+ /**
* Add a project to the user database to connect additional metadata that is not stored in openBIS
* The project is uniquely recognizable by its openBIS project identifier, containing space and
* project code
* @param projectIdentifier a project identifier object denoting the openBIS identifier
* @param projectApplication a project application object used to add additional metadata
*/
- public Project addProjectAndConnectPersonsInUserDB(projectIdentifier, projectApplication) {
- //collect infos needed for database
- String projectTitle = projectApplication.getProjectTitle()
- Customer customer = projectApplication.getCustomer()
- ProjectManager projectManager = projectApplication.getProjectManager()
-
- //fetch needed person ids from database
- int customerID = personDBConnector.getPersonId(customer)
- int managerID = personDBConnector.getPersonId(projectManager)
-
- Connection connection = connectionProvider.connect()
- connection.setAutoCommit(false)
-
- connection.withCloseable {it ->
- try {
- int projectID = addProjectToDB(it, projectIdentifier, projectTitle)
- addPersonToProject(it, projectID, managerID, "Manager")
- addPersonToProject(it, projectID, customerID, "PI")
+ Project addProjectAndConnectPersonsInUserDB(ProjectIdentifier projectIdentifier,
+ ProjectApplication projectApplication) {
+ //collect infos needed for database
+ String projectTitle = projectApplication.getProjectTitle()
+ Customer customer = projectApplication.getCustomer()
+ ProjectManager projectManager = projectApplication.getProjectManager()
- it.commit()
-
- } catch (Exception e) {
- log.error(e.message)
- log.error(e.stackTrace.join("\n"))
- it.rollback()
-
- throw new DatabaseQueryException("Could not add person and project data to user database.")
+ //fetch needed person ids from database
+ int customerID = personDbConnector.getPersonId(customer)
+ int managerID = personDbConnector.getPersonId(projectManager)
+
+ Connection connection = connectionProvider.connect()
+ connection.setAutoCommit(false)
+
+ connection.withCloseable {it ->
+ try {
+ int projectID = addProjectToDB(it, projectIdentifier.toString(), projectTitle)
+ addPersonToProject(it, projectID, managerID, "Manager")
+ addPersonToProject(it, projectID, customerID, "PI")
+
+ it.commit()
+
+ } catch (Exception e) {
+ log.error(e.message)
+ log.error(e.stackTrace.join("\n"))
+ it.rollback()
+
+ throw new DatabaseQueryException("Could not add person and project data to user database.")
+ }
}
- }
- return new Project(projectIdentifier, projectTitle, projectApplication.getLinkedOffer())
+ return new Project.Builder(projectIdentifier, projectTitle)
+ .linkedOfferId(projectApplication.linkedOffer).build()
}
- private boolean isProjectInDB(String projectIdentifier) {
- log.debug("Looking for project " + projectIdentifier + " in the DB");
- String sql = "SELECT * from projects WHERE openbis_project_identifier = ?";
- Connection connection = connectionProvider.connect()
- connection.withCloseable { it ->
- PreparedStatement statement = it.prepareStatement(sql);
- statement.setString(1, projectIdentifier);
- ResultSet rs = statement.executeQuery();
- if (rs.next()) {
- return true
+ private boolean isProjectInDB(String projectIdentifier) {
+ String sql = "SELECT * from projects WHERE openbis_project_identifier = ?"
+ Connection connection = connectionProvider.connect()
+ connection.withCloseable { it ->
+ PreparedStatement statement = it.prepareStatement(sql)
+ statement.setString(1, projectIdentifier)
+ ResultSet rs = statement.executeQuery()
+ if (rs.next()) {
+ return true
+ }
}
- }
- return false;
+ return false
}
- private int addProjectToDB(Connection connection, String projectIdentifier, String projectName) {
- if(isProjectInDB(projectIdentifier)) {
- throw new ProjectExistsException("Project "+projectIdentifier+" is already in the user database")
- }
- log.debug("Trying to add project " + projectIdentifier + " to the person DB");
- String sql = "INSERT INTO projects (openbis_project_identifier, short_title) VALUES(?, ?)";
- try (PreparedStatement statement =
- connection.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS)) {
- statement.setString(1, projectIdentifier);
- statement.setString(2, projectName);
- statement.execute();
- ResultSet rs = statement.getGeneratedKeys();
- if (rs.next()) {
- logout(conn);
- log.debug("Successful.");
- return rs.getInt(1);
+ private int addProjectToDB(Connection connection, String projectIdentifier, String projectName) {
+ if(isProjectInDB(projectIdentifier)) {
+ throw new ProjectExistsException("Project "+projectIdentifier+" is already in the user database")
}
- }
- return -1
+ log.debug("Trying to add project " + projectIdentifier + " to the person DB")
+ String sql = "INSERT INTO projects (openbis_project_identifier, short_title) VALUES(?, ?)"
+ try (PreparedStatement statement =
+ connection.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS)) {
+ statement.setString(1, projectIdentifier)
+ statement.setString(2, projectName)
+ statement.execute()
+ ResultSet rs = statement.getGeneratedKeys()
+ if (rs.next()) {
+ log.debug("Successful.")
+ return rs.getInt(1)
+ }
+ }
+ return -1
}
- private void addPersonToProject(Connection connection, int projectID, int personID, String role) {
- if (!hasPersonRoleInProject(personID, projectID, role)) {
- log.debug("Trying to add person with role " + role + " to a project.");
- String sql =
- "INSERT INTO projects_persons (project_id, person_id, project_role) VALUES(?, ?, ?)";
- try (PreparedStatement statement =
- connection.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS)) {
- statement.setInt(1, projectID);
- statement.setInt(2, personID);
- statement.setString(3, role);
- statement.execute();
- log.debug("Successful.");
- } catch (Exception e) {
- log.error("SQL operation unsuccessful: " + e.getMessage());
- e.printStackTrace();
- }
+ private void addPersonToProject(Connection connection, int projectID, int personID, String role) {
+ if (!hasPersonRoleInProject(personID, projectID, role)) {
+ log.debug("Trying to add person with role " + role + " to a project.")
+ String sql =
+ "INSERT INTO projects_persons (project_id, person_id, project_role) VALUES(?, ?, ?)";
+ try (PreparedStatement statement =
+ connection.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS)) {
+ statement.setInt(1, projectID)
+ statement.setInt(2, personID)
+ statement.setString(3, role)
+ statement.execute()
+ } catch (Exception e) {
+ log.error("SQL operation unsuccessful: " + e.getMessage())
+ e.printStackTrace()
+ }
+ }
}
- }
-
- private boolean hasPersonRoleInProject(int personID, int projectID, String role) {
- logger.info("Checking if person already has this role in the project.");
- String sql =
- "SELECT * from projects_persons WHERE person_id = ? AND project_id = ? and project_role = ?";
- boolean res = false;
- Connection connection = connectionProvider.connect()
- try {
- PreparedStatement statement = connection.prepareStatement(sql);
- statement.setInt(1, personID);
- statement.setInt(2, projectID);
- statement.setString(3, role);
- ResultSet rs = statement.executeQuery();
- if (rs.next()) {
- res = true;
- logger.info("person already has this role!");
+
+ private boolean hasPersonRoleInProject(int personID, int projectID, String role) {
+ String sql =
+ "SELECT * from projects_persons WHERE person_id = ? AND project_id = ? and project_role = ?"
+ boolean res = false
+ Connection connection = connectionProvider.connect()
+ try {
+ PreparedStatement statement = connection.prepareStatement(sql)
+ statement.setInt(1, personID)
+ statement.setInt(2, projectID)
+ statement.setString(3, role)
+ ResultSet rs = statement.executeQuery()
+ if (rs.next()) {
+ res = true
+ }
+ } catch (Exception e) {
+ log.error("SQL operation unsuccessful: " + e.getMessage())
+ e.printStackTrace()
}
- } catch (Exception e) {
- logger.error("SQL operation unsuccessful: " + e.getMessage());
- e.printStackTrace();
- }
- logout(conn);
- return res;
+ return res
}
}
diff --git a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/projects/ProjectMainConnector.groovy b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/projects/ProjectMainConnector.groovy
index b5ba78f3c..07fadb8e7 100644
--- a/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/projects/ProjectMainConnector.groovy
+++ b/offer-manager-app/src/main/groovy/life/qbic/portal/offermanager/dataresources/projects/ProjectMainConnector.groovy
@@ -14,6 +14,8 @@ import life.qbic.datamodel.dtos.business.*
import life.qbic.datamodel.dtos.projectmanagement.*
import life.qbic.business.exceptions.DatabaseQueryException
+import life.qbic.datamodel.identifiers.ExperimentCodeFunctions
+
import java.sql.Connection
import java.sql.PreparedStatement
import java.sql.ResultSet
@@ -21,13 +23,25 @@ import java.sql.Statement
import life.qbic.openbis.openbisclient.OpenBisClient
+import javax.xml.bind.JAXBElement;
+import javax.xml.bind.JAXBException;
+import life.qbic.xml.manager.StudyXMLParser
+import life.qbic.xml.study.Qexperiment
+
import ch.ethz.sis.openbis.generic.asapi.v3.dto.operation.SynchronousOperationExecutionOptions
import ch.ethz.sis.openbis.generic.asapi.v3.dto.common.operation.IOperation
import ch.ethz.sis.openbis.generic.asapi.v3.dto.project.create.CreateProjectsOperation
import ch.ethz.sis.openbis.generic.asapi.v3.dto.project.create.ProjectCreation
+import ch.ethz.sis.openbis.generic.asapi.v3.dto.experiment.create.ExperimentCreation
+import ch.ethz.sis.openbis.generic.asapi.v3.dto.experiment.id.ExperimentIdentifier
+import ch.ethz.sis.openbis.generic.asapi.v3.dto.experiment.create.CreateExperimentsOperation
+import ch.ethz.sis.openbis.generic.asapi.v3.dto.sample.create.SampleCreation
+import ch.ethz.sis.openbis.generic.asapi.v3.dto.sample.create.CreateSamplesOperation
import ch.ethz.sis.openbis.generic.asapi.v3.dto.space.create.CreateSpacesOperation
import ch.ethz.sis.openbis.generic.asapi.v3.dto.space.create.SpaceCreation
import ch.ethz.sis.openbis.generic.asapi.v3.dto.space.id.SpacePermId
+import ch.ethz.sis.openbis.generic.asapi.v3.dto.entitytype.id.EntityTypePermId
+import life.qbic.portal.offermanager.dataresources.offers.ProjectAssistant
/**
@@ -37,147 +51,194 @@ import ch.ethz.sis.openbis.generic.asapi.v3.dto.space.id.SpacePermId
* transferring data to the project/customer db and openBIS
*
* @since 1.0.0
- *
*/
@Log4j2
@CompileStatic
class ProjectMainConnector implements CreateProjectDataSource, CreateProjectSpaceDataSource {
- /**
- * A connection to the project (and customer) database used to create queries.
- */
- private final ProjectDbConnector projectDbConnector
- private final OpenBisClient openbisClient
- private List openbisSpaces
- private List openbisProjects
+ /**
+ * A connection to the project (and customer) database used to create queries.
+ */
+ private final ProjectDbConnector projectDbConnector
+ private final OpenBisClient openbisClient
+ private final ProjectAssistant projectAssistant
+ private List openbisSpaces
+ private List openbisProjects
- /**
+ /**
* Constructor for a ProjectMainConnector
* @param projectDbConnector a connector enabling interaction with the project database
* @param openbisClient an openBIS client API object
*/
- ProjectMainConnector(ProjectDbConnector projectDbConnector, OpenBisClient openbisClient) {
- this.projectDbConnector = projectDbConnector
- this.openbisClient = openbisClient
- fetchExistingSpaces()
- fetchExistingProjects()
- }
-
- private void fetchExistingSpaces() {
- this.openbisSpaces = new ArrayList<>()
- for(String spaceName : openbisClient.listSpaces()) {
- this.openbisSpaces.add(new ProjectSpace(spaceName))
+ ProjectMainConnector(ProjectDbConnector projectDbConnector,
+ OpenBisClient openbisClient,
+ ProjectAssistant projectAssistant) {
+ this.projectDbConnector = projectDbConnector
+ this.openbisClient = openbisClient
+ this.projectAssistant = projectAssistant
+ fetchExistingSpaces()
+ fetchExistingProjects()
+ }
+
+ private void fetchExistingSpaces() {
+ this.openbisSpaces = new ArrayList<>()
+ for (String spaceName : openbisClient.listSpaces()) {
+ this.openbisSpaces.add(new ProjectSpace(spaceName))
+ }
+ }
+
+ /**
+ * Returns a copy of the list of available project spaces that has been fetched from openBIS upon creation of this class instance
+ */
+ List listSpaces() {
+ return new ArrayList(openbisSpaces)
+ }
+
+ private void fetchExistingProjects() {
+ //projectDbConnector.fetchProjects() might be used at some point to fetch more metadata
+
+ openbisProjects = []
+ for (ch.ethz.sis.openbis.generic.asapi.v3.dto.project.Project openbisProject : openbisClient.listProjects()) {
+ try {
+ ProjectSpace space = new ProjectSpace(openbisProject.getSpace().getCode())
+ ProjectCode code = new ProjectCode(openbisProject.getCode())
+ openbisProjects.add(new ProjectIdentifier(space, code))
+ } catch (Exception e) {
+ log.error(e.message)
+ }
+ }
+ }
+
+ private void createOpenbisSpace(String spaceName, String description) {
+ SpaceCreation space = new SpaceCreation()
+ space.setCode(spaceName)
+
+ space.setDescription(description)
+
+ IOperation operation = new CreateSpacesOperation(space)
+ handleOperations(operation)
}
- }
-
- /**
- * Returns a copy of the list of available project spaces that has been fetched from openBIS upon creation of this class instance
- */
- public List listSpaces() {
- return new ArrayList(openbisSpaces);
- }
-
- private void fetchExistingProjects() {
- //projectDbConnector.fetchProjects() might be used at some point to fetch more metadata
-
- openbisProjects = []
- for(ch.ethz.sis.openbis.generic.asapi.v3.dto.project.Project openbisProject : openbisClient.listProjects()) {
- try {
- ProjectSpace space = new ProjectSpace(openbisProject.getSpace().getCode())
- ProjectCode code = new ProjectCode(openbisProject.getCode())
- openbisProjects.add(new ProjectIdentifier(space, code))
- } catch (Exception e) {
- log.error(e.message)
- }
+
+ private void createOpenbisProject(ProjectSpace space, ProjectCode projectCode, String description) {
+ ProjectCreation project = new ProjectCreation()
+ project.setCode(projectCode.toString())
+ project.setSpaceId(new SpacePermId(space.toString()))
+ project.setDescription(description)
+
+ IOperation operation = new CreateProjectsOperation(project)
+ handleOperations(operation)
}
- }
- private void createOpenbisSpace(String spaceName, String description) {
- SpaceCreation space = new SpaceCreation()
- space.setCode(spaceName)
+ private void setupEmptyExperimentalDesign(ProjectSpace space, ProjectCode projectCodeObj)
+ throws JAXBException {
+ StudyXMLParser xmlParser = new StudyXMLParser()
+ JAXBElement res =
+ xmlParser.createNewDesign(new HashSet<>(), new ArrayList<>(), new HashMap<>(), new HashMap<>())
+ String emptyStudyXML = xmlParser.toString(res)
+
+ String spaceCode = space.toString()
+ String projectCode = projectCodeObj.toString()
+
+ String experimentCode = projectCode + "_INFO"
+ String sampleCode = projectCode + "000"
+ String experimentIdentifier = ExperimentCodeFunctions.getInfoExperimentID(spaceCode, projectCode)
- space.setDescription(description)
+ Map properties = new HashMap<>()
+ properties.put("Q_EXPERIMENTAL_SETUP", emptyStudyXML)
- IOperation operation = new CreateSpacesOperation(space)
- handleOperations(operation)
- }
+ createOpenbisExperiment(spaceCode, projectCode, experimentCode, "Q_PROJECT_DETAILS", properties)
- private void createOpenbisProject(ProjectSpace space, ProjectCode projectCode, String description) {
- ProjectCreation project = new ProjectCreation();
- project.setCode(projectCode.toString());
- project.setSpaceId(new SpacePermId(space.toString()));
- project.setDescription(description);
+ createOpenbisSample(spaceCode, experimentIdentifier, sampleCode, "Q_ATTACHMENT_SAMPLE", new HashMap<>())
+}
+
+private void createOpenbisExperiment(String spaceCode, String projectCode, String experimentCode, String experimentType, Map properties) {
+ ExperimentCreation experiment = new ExperimentCreation()
+ experiment.setCode(experimentCode)
+ experiment.setProjectId(new ch.ethz.sis.openbis.generic.asapi.v3.dto.project.id.ProjectIdentifier(spaceCode, projectCode))
+ experiment.setTypeId(new EntityTypePermId(experimentType))
+ experiment.setProperties(properties)
+
+ IOperation operation = new CreateExperimentsOperation(experiment)
+ handleOperations(operation)
+}
- IOperation operation = new CreateProjectsOperation(project);
- handleOperations(operation);
- }
+private void createOpenbisSample(String spaceCode, String experimentIdentifier, String sampleCode, String sampleType, Map properties) {
+ SampleCreation sampleCreation = new SampleCreation()
+ sampleCreation.setTypeId(new EntityTypePermId(sampleType))
+ sampleCreation.setSpaceId(new SpacePermId(spaceCode))
- /**
- * Returns a copied list of existing projects fetched upon creation of this class
- */
- public List fetchProjects() {
- return new ArrayList(openbisProjects);
- }
+ sampleCreation.setExperimentId(new ExperimentIdentifier(experimentIdentifier))
+ sampleCreation.setCode(sampleCode)
- @Override
+ sampleCreation.setProperties(properties)
+
+ IOperation operation = new CreateSamplesOperation(sampleCreation)
+ handleOperations(operation)
+}
+
+ /**
+ * Returns a copied list of existing projects fetched upon creation of this class
+ */
+ List fetchProjects() {
+ return new ArrayList(openbisProjects)
+ }
+
+ @Override
void createProjectSpace(ProjectSpace projectSpace) throws ProjectSpaceExistsException, DatabaseQueryException {
- String spaceName = projectSpace.getName()
- if(openbisClient.spaceExists(spaceName)) {
- throw new ProjectSpaceExistsException("Project space "+spaceName+" could not be created, as it exists in openBIS already!")
- }
- try {
- //we don't provide a description in our data model for now, but it's optional anyway
- createOpenbisSpace(spaceName, "")
-
- } catch (Exception e) {
- log.error(e.message)
- log.error(e.stackTrace.join("\n"))
- throw new DatabaseQueryException("Could not create project space.")
- }
+ String spaceName = projectSpace.getName()
+ if (openbisClient.spaceExists(spaceName)) {
+ throw new ProjectSpaceExistsException("Project space " + spaceName + " could not be created, as it exists in openBIS already!")
+ }
+ try {
+ //we don't provide a description in our data model for now, but it's optional anyway
+ createOpenbisSpace(spaceName, "")
+
+ } catch (Exception e) {
+ log.error(e.message)
+ log.error(e.stackTrace.join("\n"))
+ throw new DatabaseQueryException("Could not create project space.")
+ }
}
- @Override
+ @Override
Project createProject(ProjectApplication projectApplication) throws ProjectExistsException, DatabaseQueryException {
- //collect infos needed for openBIS
- ProjectSpace space = projectApplication.getProjectSpace()
- ProjectCode projectCode = projectApplication.getProjectCode()
- String description = projectApplication.getProjectObjective()
-
- ProjectIdentifier projectIdentifier = new ProjectIdentifier(space, projectCode)
-
- //collect infos needed for database
- String projectTitle = projectApplication.getProjectTitle()
- Customer customer = projectApplication.getCustomer()
- ProjectManager projectManager = projectApplication.getProjectManager()
-
- //if the space does not exist, an error shall be thrown
- if (!openbisClient.spaceExists(space.toString())) {
- throw new SpaceNonExistingException("Could not create project because of non-existent space: "+space.toString())
- }
- if (openbisClient.projectExists(space.toString(), projectCode.toString())) {
- throw new ProjectExistsException("Project "+projectIdentifier.toString()+" could not be created, as it exists in openBIS already!")
- }
- try {
- createOpenbisProject(space, projectCode, description)
- } catch (Exception e) {
- log.error(e.message)
- log.error(e.stackTrace.join("\n"))
- throw new DatabaseQueryException("Could not create project.")
- }
-
- return projectDbConnector.addProjectAndConnectPersonsInUserDB(projectIdentifier, projectApplication)
+ //collect infos needed for openBIS
+ ProjectSpace space = projectApplication.getProjectSpace()
+ ProjectCode projectCode = projectApplication.getProjectCode()
+ String description = projectApplication.getProjectObjective()
+
+ ProjectIdentifier projectIdentifier = new ProjectIdentifier(space, projectCode)
+
+ //if the space does not exist, an error shall be thrown
+ if (!openbisClient.spaceExists(space.toString())) {
+ throw new SpaceNonExistingException("Could not create project because of non-existent space: " + space.toString())
+ }
+ if (openbisClient.projectExists(space.toString(), projectCode.toString())) {
+ throw new ProjectExistsException("Project " + projectIdentifier.toString() + " could not be created, as it exists in openBIS already!")
+ }
+ try {
+ createOpenbisProject(space, projectCode, description)
+ setupEmptyExperimentalDesign(space, projectCode)
+ projectAssistant.linkOfferWithProject(projectApplication.linkedOffer, projectIdentifier)
+ } catch (Exception e) {
+ log.error(e.message)
+ log.error(e.stackTrace.join("\n"))
+ throw new DatabaseQueryException("Could not create project.")
+ }
+
+ return projectDbConnector.addProjectAndConnectPersonsInUserDB(projectIdentifier, projectApplication)
}
-
- private void handleOperations(IOperation operation) {
- IApplicationServerApi api = openbisClient.getV3()
-
- SynchronousOperationExecutionOptions executionOptions = new SynchronousOperationExecutionOptions()
- List operationOptions = Arrays.asList(operation)
- try {
- api.executeOperations(openbisClient.getSessionToken(), operationOptions, executionOptions)
- } catch (Exception e) {
- log.error("Unexpected exception during openBIS operation.", e)
- throw e
+
+ private void handleOperations(IOperation operation) {
+ IApplicationServerApi api = openbisClient.getV3()
+
+ SynchronousOperationExecutionOptions executionOptions = new SynchronousOperationExecutionOptions()
+ List operationOptions = Arrays.asList(operation)
+ try {
+ api.executeOperations(openbisClient.getSessionToken(), operationOptions, executionOptions)
+ } catch (Exception e) {
+ log.error("Unexpected exception during openBIS operation.", e)
+ throw e
+ }
}
- }
}
diff --git a/offer-manager-app/src/main/resources/.gitignore b/offer-manager-app/src/main/resources/.gitignore
deleted file mode 100644
index b684fa746..000000000
--- a/offer-manager-app/src/main/resources/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-developer.properties
\ No newline at end of file
diff --git a/offer-manager-app/src/test/groovy/life/qbic/portal/qoffer2/products/ProductResourceServiceSpec.groovy b/offer-manager-app/src/test/groovy/life/qbic/portal/qoffer2/products/ProductResourceServiceSpec.groovy
new file mode 100644
index 000000000..a152fbcb1
--- /dev/null
+++ b/offer-manager-app/src/test/groovy/life/qbic/portal/qoffer2/products/ProductResourceServiceSpec.groovy
@@ -0,0 +1,49 @@
+package life.qbic.portal.qoffer2.products
+
+import life.qbic.datamodel.dtos.business.services.PrimaryAnalysis
+import life.qbic.datamodel.dtos.business.services.Product
+import life.qbic.datamodel.dtos.business.services.ProductUnit
+import life.qbic.datamodel.dtos.business.services.Sequencing
+import life.qbic.portal.offermanager.dataresources.database.ConnectionProvider
+import life.qbic.portal.offermanager.dataresources.products.ProductsDbConnector
+import life.qbic.portal.offermanager.dataresources.products.ProductsResourcesService
+import spock.lang.Specification
+
+import java.sql.Connection
+
+/**
+ * Tests the functionality of the {@link life.qbic.portal.offermanager.dataresources.ResourcesService} of products {@link life.qbic.portal.offermanager.dataresources.products.ProductsResourcesService}
+ *
+ * @since 1.0.0
+ *
+*/
+class ProductResourceServiceSpec extends Specification{
+
+
+ def "Products can be removed from the list"(){
+ given: "a list of products"
+ Sequencing sequencing = new Sequencing("test product", "this is a test sequencing product", 0.5, ProductUnit.PER_GIGABYTE, "123")
+ PrimaryAnalysis primaryAnalysis = new PrimaryAnalysis("test product", "this is a test analysis product", 0.5, ProductUnit.PER_GIGABYTE, "123")
+
+ PrimaryAnalysis primaryAnalysisCopy = new PrimaryAnalysis("test product", "this is a test analysis product", 0.5, ProductUnit.PER_GIGABYTE, "123")
+
+ and: "the database session is mocked"
+ // the connection must only provide precompiled statements for the expected query template
+ Connection connection = Stub( Connection)
+
+ //and: "a ConnectionProvider providing the stubbed connection"
+ ConnectionProvider connectionProvider = Stub (ConnectionProvider, {it.connect() >> connection})
+
+ and: "a resource service"
+ ProductsResourcesService resourcesService = new ProductsResourcesService(new ProductsDbConnector(connectionProvider))
+
+ when: "a product is removed"
+ resourcesService.addToResource(sequencing)
+ resourcesService.addToResource(primaryAnalysis)
+ resourcesService.removeFromResource(primaryAnalysisCopy)
+
+ then: "the list does not longer contain the removed product"
+ resourcesService.iterator().toList().size() == 1
+ resourcesService.iterator().toList().get(0) == sequencing
+ }
+}
diff --git a/offer-manager-app/src/test/groovy/life/qbic/portal/qoffer2/products/ProductsDbConnectorSpec.groovy b/offer-manager-app/src/test/groovy/life/qbic/portal/qoffer2/products/ProductsDbConnectorSpec.groovy
index f34c8ba89..45e1f3b94 100644
--- a/offer-manager-app/src/test/groovy/life/qbic/portal/qoffer2/products/ProductsDbConnectorSpec.groovy
+++ b/offer-manager-app/src/test/groovy/life/qbic/portal/qoffer2/products/ProductsDbConnectorSpec.groovy
@@ -1,6 +1,7 @@
package life.qbic.portal.qoffer2.products
import groovy.sql.GroovyRowResult
+import life.qbic.datamodel.dtos.business.ProductId
import life.qbic.datamodel.dtos.business.services.AtomicProduct
import life.qbic.datamodel.dtos.business.services.PrimaryAnalysis
import life.qbic.datamodel.dtos.business.services.Product
@@ -120,4 +121,39 @@ class ProductsDbConnectorSpec extends Specification {
0 | "Primary Bioinformatics" | "Sample QC with report" | "Sample QC" | 49.99 | ProductUnit.PER_SAMPLE | "1"
}
+
+ def "Fetch(life.qbic.datamodel.dtos.business.ProductId) ignores rows with incomplete or uninterpretable information"() {
+ given: "some expected query results"
+ GroovyMock(SqlExtensions, global: true)
+ SqlExtensions.toRowResult(_ as ResultSet) >> new GroovyRowResult(
+ ["id":id, "category":category, "description":description, "productName": productName,
+ "unitPrice": unitPrice, "unit": unit, "productId": productId])
+
+ and: "a result set containing only 6 rows"
+ ResultSet resultSet = Stub(ResultSet, {
+ it.next() >>> [true, false]
+ })
+ PreparedStatement statement = Stub(PreparedStatement, {
+ it.executeQuery() >> resultSet
+ })
+
+ and: "a valid connection"
+ Connection connection = Stub(Connection, {it.prepareStatement(_ as String) >> statement})
+ ConnectionProvider provider = Stub(ConnectionProvider, {it.connect() >> connection})
+ def connector = new ProductsDbConnector(provider)
+
+ when: "the query is executed"
+ Optional result = connector.fetch(new ProductId("DS", "1"))
+
+ then:
+ ! result.isPresent()
+
+ where: "available products information is as follows"
+ id | category | description | productName | unitPrice | unit | productId
+ 0 | "Unknown category" | "Sample QC with report" | "Sample QC" | 49.99 | "Sample" | "DS_1"
+ 1 | "Primary Bioinformatics" | null | "Sample QC with report" | 49.99 | "Sample" | "DS_1"
+ 2 | "Primary Bioinformatics" | "Sample QC with report" | null | 49.99 | "Sample" | "DS_1"
+ 4 | "Primary Bioinformatics" | "Sample QC with report" | "Sample QC" | 49.99 | "Unknown Unit" | "DS_1"
+ 5 | "Primary Bioinformatics" | "Sample QC with report" | "Sample QC" | 49.99 | "Sample" | "This is some random string. Lorem ipsum"
+ }
}
diff --git a/offer-manager-domain/pom.xml b/offer-manager-domain/pom.xml
index 121a14f41..056d436bb 100644
--- a/offer-manager-domain/pom.xml
+++ b/offer-manager-domain/pom.xml
@@ -7,7 +7,7 @@
offer-manager
life.qbic
- 1.0.0-alpha.4
+ 1.0.0-alpha.5
@@ -23,7 +23,7 @@
log4j
1.2.17
-
+
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/offers/Converter.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/offers/Converter.groovy
index 3e0a29793..2d760d918 100644
--- a/offer-manager-domain/src/main/groovy/life/qbic/business/offers/Converter.groovy
+++ b/offer-manager-domain/src/main/groovy/life/qbic/business/offers/Converter.groovy
@@ -24,7 +24,7 @@ import life.qbic.datamodel.dtos.business.ProjectManager
*/
class Converter {
static life.qbic.datamodel.dtos.business.Offer convertOfferToDTO(Offer offer) {
- new life.qbic.datamodel.dtos.business.Offer.Builder(
+ def builder = new life.qbic.datamodel.dtos.business.Offer.Builder(
offer.customer,
offer.projectManager,
offer.projectTitle,
@@ -44,7 +44,12 @@ class Converter {
.itemsWithOverheadNet(offer.overheadItemsNet)
.itemsWithoutOverheadNet(offer.noOverheadItemsNet)
.overheadRatio(offer.overheadRatio)
- .build()
+ // Add the project identifier, if one is present
+ if (offer.associatedProject.isPresent()) {
+ builder.associatedProject(offer.associatedProject.get())
+ }
+
+ return builder.build()
}
static Offer buildOfferForCostCalculation(List items,
Affiliation affiliation) {
@@ -76,7 +81,7 @@ class Converter {
}
static life.qbic.business.offers.Offer convertDTOToOffer(life.qbic.datamodel.dtos.business.Offer offer) {
- new Offer.Builder(
+ def builder = new Offer.Builder(
offer.customer,
offer.projectManager,
offer.projectTitle,
@@ -86,6 +91,12 @@ class Converter {
.identifier(buildOfferId(offer.identifier))
//ToDo Is this the correct mapping?
.creationDate(offer.modificationDate)
- .build()
+
+ // We optionally add the associated project, if present
+ if (offer.associatedProject.isPresent()) {
+ builder.associatedProject(offer.associatedProject.get())
+ }
+
+ return builder.build()
}
}
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/offers/Offer.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/offers/Offer.groovy
index 5686fc735..1a016f58a 100644
--- a/offer-manager-domain/src/main/groovy/life/qbic/business/offers/Offer.groovy
+++ b/offer-manager-domain/src/main/groovy/life/qbic/business/offers/Offer.groovy
@@ -15,6 +15,7 @@ import life.qbic.datamodel.dtos.business.services.ProjectManagement
import life.qbic.business.offers.identifier.OfferId
import life.qbic.datamodel.dtos.business.services.SecondaryAnalysis
import life.qbic.datamodel.dtos.business.services.Sequencing
+import life.qbic.datamodel.dtos.projectmanagement.ProjectIdentifier
import java.nio.charset.StandardCharsets
import java.security.MessageDigest
@@ -105,6 +106,11 @@ class Offer {
*/
private static final double VAT = 0.19
+ /**
+ * A project that has been created from this offer (optional)
+ */
+ private Optional associatedProject
+
private static Date calculateExpirationDate(Date date) {
use (TimeCategory) {
return date + 90.days
@@ -123,6 +129,7 @@ class Offer {
Affiliation selectedCustomerAffiliation
List availableVersions
double overheadRatio
+ Optional associatedProject
Builder(Customer customer, ProjectManager projectManager, String projectTitle, String projectObjective, List items, Affiliation selectedCustomerAffiliation) {
this.customer = Objects.requireNonNull(customer, "Customer must not be null")
@@ -136,6 +143,7 @@ class Offer {
// copy all immutable items to out internal list
items.each {this.items.add(it)}
this.selectedCustomerAffiliation = Objects.requireNonNull(selectedCustomerAffiliation, "Customer Affiliation must not be null")
+ this.associatedProject = Optional.empty()
}
Builder creationDate(Date creationDate) {
@@ -158,6 +166,11 @@ class Offer {
return this
}
+ Builder associatedProject(ProjectIdentifier associatedProject) {
+ this.associatedProject = Optional.of(associatedProject)
+ return this
+ }
+
Offer build() {
return new Offer(this)
@@ -185,7 +198,11 @@ class Offer {
this.itemsWithOverheadNetPrice = getOverheadItemsNet()
this.itemsWithoutOverheadNetPrice = getNoOverheadItemsNet()
this.overheadRatio = determineOverhead()
-
+ if (builder.associatedProject.isPresent()) {
+ this.associatedProject = Optional.of(builder.associatedProject.get())
+ } else {
+ this.associatedProject = Optional.empty()
+ }
}
/**
@@ -219,8 +236,10 @@ class Offer {
double getOverheadSum() {
double overheadSum = 0
items.each {
- // No overheads are assigned for data storage and project management
- if (it.product instanceof PrimaryAnalysis || it.product instanceof SecondaryAnalysis || it.product instanceof Sequencing) {
+ if (it.product instanceof ProjectManagement || it.product instanceof DataStorage) {
+ // No overheads are assigned for data storage and project management
+ }
+ else {
overheadSum += it.quantity * it.product.unitPrice * this.overhead
}
}
@@ -252,7 +271,10 @@ class Offer {
double getOverheadItemsNet() {
double costOverheadItemsNet = 0
items.each {
- if (it.product instanceof PrimaryAnalysis || it.product instanceof SecondaryAnalysis || it.product instanceof Sequencing) {
+ if (it.product instanceof ProjectManagement || it.product instanceof DataStorage) {
+ // No overheads are assigned for data storage and project management
+ }
+ else {
costOverheadItemsNet += it.quantity * it.product.unitPrice
}
}
@@ -281,7 +303,10 @@ class Offer {
List getOverheadItems() {
List listOverheadProductItem = []
items.each {
- if (it.product instanceof PrimaryAnalysis || it.product instanceof SecondaryAnalysis || it.product instanceof Sequencing) {
+ if (it.product instanceof DataStorage || it.product instanceof ProjectManagement){
+ // No overheads are assigned for data storage and project management
+ }
+ else {
listOverheadProductItem.add(it)
}
}
@@ -297,7 +322,7 @@ class Offer {
List listNoOverheadProductItem = []
items.each {
if (it.product instanceof DataStorage || it.product instanceof ProjectManagement) {
- listNoOverheadProductItem.add(it)
+ listNoOverheadProductItem.add(it)
}
}
return listNoOverheadProductItem
@@ -343,6 +368,10 @@ class Offer {
return overheadRatio
}
+ Optional getAssociatedProject() {
+ return associatedProject
+ }
+
/**
* Returns a deep copy of all available offer versions.
*
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/products/Converter.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/products/Converter.groovy
new file mode 100644
index 000000000..359618b91
--- /dev/null
+++ b/offer-manager-domain/src/main/groovy/life/qbic/business/products/Converter.groovy
@@ -0,0 +1,117 @@
+package life.qbic.business.products
+
+import life.qbic.business.logging.Logger
+import life.qbic.business.logging.Logging
+import life.qbic.datamodel.dtos.business.ProductCategory
+import life.qbic.datamodel.dtos.business.services.DataStorage
+import life.qbic.datamodel.dtos.business.services.MetabolomicAnalysis
+import life.qbic.datamodel.dtos.business.services.PrimaryAnalysis
+import life.qbic.datamodel.dtos.business.services.Product
+import life.qbic.datamodel.dtos.business.services.ProductUnit
+import life.qbic.datamodel.dtos.business.services.ProjectManagement
+import life.qbic.datamodel.dtos.business.services.ProteomicAnalysis
+import life.qbic.datamodel.dtos.business.services.SecondaryAnalysis
+import life.qbic.datamodel.dtos.business.services.Sequencing
+
+/**
+ * Converter for {@link life.qbic.datamodel.dtos.business.services.Product}
+ *
+ * Converts a product into its respective type e.g. {@link life.qbic.datamodel.dtos.business.services.Sequencing},
+ * {@link life.qbic.datamodel.dtos.business.services.ProjectManagement},..
+ *
+ * @since 1.0.0
+ *
+*/
+class Converter {
+
+ private static final Logging log = Logger.getLogger(this.class)
+
+ /**
+ * Creates a product DTO based on its products category without a version
+ *
+ * @param category The products category which determines what kind of products is created
+ * @param description The description of the product
+ * @param name The name of the product
+ * @param unitPrice The unit price of the product
+ * @param unit The unit in which the product is measured
+ * @return
+ */
+ static Product createProduct(ProductCategory category, String name, String description, double unitPrice, ProductUnit unit){
+ long runningNumber = 0 //todo it should be possible to create products without a running number
+ return createProductWithVersion(category,name,description,unitPrice,unit,runningNumber)
+ }
+
+ /**
+ * Creates a product DTO based on its products category with a version
+ *
+ * @param category The products category which determines what kind of products is created
+ * @param description The description of the product
+ * @param name The name of the product
+ * @param unitPrice The unit price of the product
+ * @param unit The unit in which the product is measured
+ * @param runningNumber The running version number of the product
+ * @return
+ */
+ static Product createProductWithVersion(ProductCategory category, String name, String description, double unitPrice, ProductUnit unit, long runningNumber){
+ Product product = null
+ switch (category) {
+ case ProductCategory.DATA_STORAGE:
+ product = new DataStorage(name, description, unitPrice,unit, runningNumber.toString())
+ break
+ case ProductCategory.PRIMARY_BIOINFO:
+ product = new PrimaryAnalysis(name, description, unitPrice,unit, runningNumber.toString())
+ break
+ case ProductCategory.PROJECT_MANAGEMENT:
+ product = new ProjectManagement(name, description, unitPrice,unit, runningNumber.toString())
+ break
+ case ProductCategory.SECONDARY_BIOINFO:
+ product = new SecondaryAnalysis(name, description, unitPrice,unit, runningNumber.toString())
+ break
+ case ProductCategory.SEQUENCING:
+ product = new Sequencing(name, description, unitPrice,unit, runningNumber.toString())
+ break
+ case ProductCategory.PROTEOMIC:
+ product = new ProteomicAnalysis(name, description, unitPrice,unit, runningNumber.toString())
+ break
+ case ProductCategory.METABOLOMIC:
+ product = new MetabolomicAnalysis(name, description, unitPrice,unit, runningNumber.toString())
+ break
+ default:
+ log.warn("Unknown product category $category")
+ }
+ if(!product) throw new IllegalArgumentException("Cannot parse product")
+ return product
+ }
+
+ /**
+ * Retrieves the category of the given product
+ * @param product The product of a specific product category
+ * @return the product category of the given product
+ */
+ static ProductCategory getCategory(Product product){
+ if(product instanceof ProjectManagement) return ProductCategory.PROJECT_MANAGEMENT
+ if(product instanceof Sequencing) return ProductCategory.SEQUENCING
+ if(product instanceof PrimaryAnalysis) return ProductCategory.PRIMARY_BIOINFO
+ if(product instanceof SecondaryAnalysis) return ProductCategory.SECONDARY_BIOINFO
+ if(product instanceof DataStorage) return ProductCategory.DATA_STORAGE
+ if(product instanceof ProteomicAnalysis) return ProductCategory.PROTEOMIC
+ if(product instanceof MetabolomicAnalysis) return ProductCategory.METABOLOMIC
+
+ throw new IllegalArgumentException("Cannot parse category of the provided product ${product.toString()}")
+ }
+
+ static life.qbic.business.products.Product convertDTOtoProduct(Product product){
+ ProductCategory category = getCategory(product)
+ return new life.qbic.business.products.Product.Builder(category,
+ product.productName,
+ product.description,
+ product.unitPrice,
+ product.unit)
+ .build()
+
+ }
+
+ static Product convertProductToDTO(life.qbic.business.products.Product product){
+ return createProductWithVersion(product.category,product.name, product.description, product.unitPrice, product.unit, product.id.uniqueId)
+ }
+}
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/products/Product.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/products/Product.groovy
new file mode 100644
index 000000000..5d1ef13d7
--- /dev/null
+++ b/offer-manager-domain/src/main/groovy/life/qbic/business/products/Product.groovy
@@ -0,0 +1,127 @@
+package life.qbic.business.products
+
+import life.qbic.datamodel.dtos.business.ProductCategory
+import life.qbic.datamodel.dtos.business.ProductId
+import life.qbic.datamodel.dtos.business.services.ProductUnit
+
+import java.nio.charset.StandardCharsets
+import java.security.MessageDigest
+
+/**
+ * Represents the product business model
+ *
+ * This class should be used in the business context of product creation
+ *
+ * @since 1.0.0
+ *
+*/
+class Product {
+ private ProductCategory category
+ private String name
+ private String description
+ private double unitPrice
+ private ProductUnit unit
+ private ProductId id
+
+ static class Builder{
+ ProductCategory category
+ String name
+ String description
+ double unitPrice
+ ProductUnit unit
+ ProductId id
+
+ Builder(ProductCategory category, String name, String description, double unitPrice, ProductUnit unit){
+ this.category = Objects.requireNonNull(category)
+ this.name = Objects.requireNonNull(name)
+ this.description = Objects.requireNonNull(description)
+ this.unitPrice = Objects.requireNonNull(unitPrice)
+ this.unit = Objects.requireNonNull(unit)
+ }
+
+ Builder id(ProductId id){
+ this.id = id
+ return this
+ }
+
+ Product build(){
+ return new Product(this)
+ }
+ }
+
+ Product(Builder builder){
+ this.category = builder.category
+ this.name = builder.name
+ this.description = builder.description
+ this.unitPrice = builder.unitPrice
+ this.unit = builder.unit
+ }
+
+ /**
+ * Calculates the SHA checksum for the product
+ * The checksum is computed based on the product name, description, unit, unit price and the category
+ *
+ * @return a string containing the checksum for this product
+ */
+ String checksum(){
+ MessageDigest digest = MessageDigest.getInstance("SHA-256")
+ return getProductChecksum(digest,this)
+ }
+
+ /**
+ * Compute the checksum for a product based on the encryption method provided
+ *
+ * @param digest The digestor will digest the message that needs to be encrypted
+ * @param product Contains the product information
+ * @return a string that encrypts the product object
+ */
+ private static String getProductChecksum(MessageDigest digest, Product product)
+ {
+ //digest crucial offer characteristics
+ digest.update(product.name.getBytes(StandardCharsets.UTF_8))
+
+ digest.update(product.description.getBytes(StandardCharsets.UTF_8))
+
+ digest.update(product.unit.value.getBytes(StandardCharsets.UTF_8))
+ digest.update(product.unitPrice.toString().getBytes(StandardCharsets.UTF_8))
+ digest.update(product.category.toString().getBytes(StandardCharsets.UTF_8))
+
+ //Get the hash's bytes
+ byte[] bytes = digest.digest()
+
+ //This bytes[] has bytes in decimal format
+ //Convert it to hexadecimal format
+ StringBuilder sb = new StringBuilder()
+ for(int i=0; i< bytes.length ;i++)
+ {
+ sb.append(Integer.toString((bytes[i] & 0xff) + 0x100, 16).substring(1));
+ }
+
+ //return complete hash
+ return sb.toString()
+ }
+
+ ProductCategory getCategory() {
+ return category
+ }
+
+ String getName() {
+ return name
+ }
+
+ String getDescription() {
+ return description
+ }
+
+ double getUnitPrice() {
+ return unitPrice
+ }
+
+ ProductUnit getUnit() {
+ return unit
+ }
+
+ ProductId getId() {
+ return id
+ }
+}
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/products/ProductDataSource.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/products/ProductDataSource.groovy
deleted file mode 100644
index b0d47ee73..000000000
--- a/offer-manager-domain/src/main/groovy/life/qbic/business/products/ProductDataSource.groovy
+++ /dev/null
@@ -1,39 +0,0 @@
-package life.qbic.business.products
-
-import life.qbic.business.exceptions.DatabaseQueryException
-import life.qbic.datamodel.dtos.business.ProductId
-import life.qbic.datamodel.dtos.business.services.Product
-
-/**
- * Defines the methods of the Datasource implementation
- *
- * @since: 1.0.0
- *
- */
-interface ProductDataSource {
-
- /**
- * Fetches a product from the database
- * @param productId The product id of the product to be fetched
- * @return returns an optional that contains the product if it has been found
- * @since 1.0.0
- * @throws DatabaseQueryException
- */
- Optional fetch(ProductId productId) throws DatabaseQueryException
-
- /**
- * Stores a product in the database
- * @param product The product that needs to be stored
- * @since 1.0.0
- * @throws DatabaseQueryException
- */
- void store(Product product) throws DatabaseQueryException
-
- /**
- * A product is archived by setting it inactive
- * @param product The product that needs to be archived
- * @since 1.0.0
- * @throws DatabaseQueryException
- */
- void archive(Product product) throws DatabaseQueryException
-}
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProduct.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProduct.groovy
new file mode 100644
index 000000000..41093147e
--- /dev/null
+++ b/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProduct.groovy
@@ -0,0 +1,105 @@
+package life.qbic.business.products.copy
+
+import life.qbic.business.Constants
+import life.qbic.business.exceptions.DatabaseQueryException
+import life.qbic.business.logging.Logger
+import life.qbic.business.logging.Logging
+import life.qbic.business.products.Converter
+import life.qbic.business.products.create.CreateProduct
+import life.qbic.business.products.create.CreateProductDataSource
+import life.qbic.business.products.create.CreateProductInput
+import life.qbic.business.products.create.CreateProductOutput
+import life.qbic.datamodel.dtos.business.ProductId
+import life.qbic.datamodel.dtos.business.services.Product
+
+/**
+ * 4.3.2 Copy Service Product
+ *
+ * Offer Administrators are allowed to create a new permutation of an existing product.
+ *
New permutations can include changes in unit price, sequencing technology and other attributes of service products.
+ *
+ *
+ * @since: 1.0.0
+ *
+ */
+class CopyProduct implements CopyProductInput, CreateProductOutput {
+
+ private static final Logging log = Logger.getLogger(this.class)
+
+ private final CopyProductDataSource dataSource
+ private final CopyProductOutput output
+ private final CreateProductInput createProduct
+
+ /**
+ * The only constructor for this use case
+ * @param dataSource - a data source that provides mandatory functionality
+ * @param output - an output that provides mandatory functionality
+ * @param createProductInput - a CreateProduct use case that is used to create the product
+ */
+ CopyProduct(CopyProductDataSource dataSource, CopyProductOutput output, CreateProductDataSource createProductDataSource) {
+ this.dataSource = dataSource
+ this.output = output
+ this.createProduct = new CreateProduct(createProductDataSource, this)
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ void copyModified(Product product) {
+ try {
+ //1. retrieve product from db
+ Product existingProduct = getExistingProduct(product.productId)
+ //2. compare if there is a difference between the products in order
+ if (theProductHasChanged(product,existingProduct)) {
+ //3. call the CreateProduct use case (new id is created here)
+ createProduct.create(product)
+ } else {
+ foundDuplicate(product)
+ }
+ } catch (DatabaseQueryException databaseQueryException) {
+ log.error("The copied product ${product.productId.toString()} cannot be found in the database", databaseQueryException)
+ output.failNotification("The copied product ${product.productId.toString()} cannot be found in the database")
+ } catch(Exception ignore){
+ //there is no product present, this should not happen
+ log.error("An unexpected during the project creation occurred.", ignore)
+ output.failNotification("An unexpected during the project creation occurred. " +
+ "Please contact ${Constants.QBIC_HELPDESK_EMAIL}.")
+ }
+ }
+
+ private Product getExistingProduct(ProductId productId){
+ return dataSource.fetch(productId).get()
+ }
+
+ private static boolean theProductHasChanged(Product product1, Product product2){
+ life.qbic.business.products.Product copiedProduct = Converter.convertDTOtoProduct(product1)
+ life.qbic.business.products.Product oldProduct = Converter.convertDTOtoProduct(product2)
+
+ copiedProduct.checksum() != oldProduct.checksum()
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ void failNotification(String notification) {
+ output.failNotification(notification)
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ void created(Product product) {
+ output.copied(product)
+ }
+
+ /**
+ * {@inhertDoc}
+ */
+ @Override
+ void foundDuplicate(Product product) {
+ output.failNotification("A product with the same content like ${product.productName} already exists.")
+ }
+}
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProductDataSource.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProductDataSource.groovy
new file mode 100644
index 000000000..68a320c18
--- /dev/null
+++ b/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProductDataSource.groovy
@@ -0,0 +1,23 @@
+package life.qbic.business.products.copy
+
+import life.qbic.business.exceptions.DatabaseQueryException
+import life.qbic.datamodel.dtos.business.ProductId
+import life.qbic.datamodel.dtos.business.services.Product
+
+/**
+ * Data source for the {@link life.qbic.business.products.copy.CopyProduct} use case
+ *
+ * @since 1.0.0
+ */
+interface CopyProductDataSource {
+
+ /**
+ * Fetches a product from the database
+ * @param productId The product id of the product to be fetched
+ * @return returns an optional that contains the product if it has been found
+ * @since 1.0.0
+ * @throws life.qbic.business.exceptions.DatabaseQueryException
+ */
+ Optional fetch(ProductId productId) throws DatabaseQueryException
+
+}
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProductInput.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProductInput.groovy
new file mode 100644
index 000000000..6abf69bcb
--- /dev/null
+++ b/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProductInput.groovy
@@ -0,0 +1,20 @@
+package life.qbic.business.products.copy
+
+import life.qbic.datamodel.dtos.business.ProductId
+import life.qbic.datamodel.dtos.business.services.Product
+
+/**
+ * Input interface for the {@link CopyProduct} use case
+ *
+ * @since: 1.0.0
+ *
+ */
+interface CopyProductInput {
+
+ /**
+ * Creates a product and populates it with provided information
+ * @param product The modified product information. The identifier should already be present.
+ * @since 1.0.0
+ */
+ void copyModified(Product product)
+}
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProductOutput.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProductOutput.groovy
new file mode 100644
index 000000000..3428c9b62
--- /dev/null
+++ b/offer-manager-domain/src/main/groovy/life/qbic/business/products/copy/CopyProductOutput.groovy
@@ -0,0 +1,20 @@
+package life.qbic.business.products.copy
+
+import life.qbic.business.UseCaseFailure
+import life.qbic.datamodel.dtos.business.services.Product
+
+/**
+ * Output interface for the {@link CopyProduct} use case
+ *
+ * @since: 1.0.0
+ *
+ */
+interface CopyProductOutput extends UseCaseFailure {
+
+ /**
+ * A copy of a product has been created. This method is called after the copied product has been stored in the database.
+ * @param product The product that has been copied
+ * @since 1.0.0
+ */
+ void copied(Product product)
+}
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/products/create/CreateProduct.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/products/create/CreateProduct.groovy
index f16f4682c..d61b60bc9 100644
--- a/offer-manager-domain/src/main/groovy/life/qbic/business/products/create/CreateProduct.groovy
+++ b/offer-manager-domain/src/main/groovy/life/qbic/business/products/create/CreateProduct.groovy
@@ -1,8 +1,12 @@
package life.qbic.business.products.create
+import life.qbic.business.Constants
import life.qbic.business.exceptions.DatabaseQueryException
import life.qbic.business.logging.Logger
import life.qbic.business.logging.Logging
+import life.qbic.business.products.Converter
+import life.qbic.datamodel.dtos.business.ProductCategory
+import life.qbic.datamodel.dtos.business.ProductId
import life.qbic.datamodel.dtos.business.services.Product
/**
@@ -12,7 +16,6 @@ import life.qbic.datamodel.dtos.business.services.Product
*
*
* @since: 1.0.0
-
*
*/
class CreateProduct implements CreateProductInput {
@@ -28,14 +31,23 @@ class CreateProduct implements CreateProductInput {
@Override
void create(Product product) {
try {
- dataSource.store(product)
- output.created(product)
+ ProductId createdProductId = dataSource.store(product)
+ //create product with new product ID
+ ProductCategory category = Converter.getCategory(product)
+ Product storedProduct = Converter.createProductWithVersion(category,product.productName,product.description,product.unitPrice, product.unit, createdProductId.uniqueId)
+
+ output.created(storedProduct)
} catch(DatabaseQueryException databaseQueryException) {
log.error("Product creation failed", databaseQueryException)
- output.failNotification("Could not create product $product.productName with id $product.productId")
+ output.failNotification("Could not create new product $product.productName")
} catch(ProductExistsException productExistsException) {
- log.warn("Product \"$product.productName\" already existed.", productExistsException)
+ log.warn("Product $product.productName with identifier $product.productId already exists.", productExistsException)
output.foundDuplicate(product)
+ } catch(Exception exception) {
+ log.error("An unexpected during the project creation occurred.", exception)
+ output.failNotification("An unexpected during the project creation occurred. " +
+ "Please contact ${Constants.QBIC_HELPDESK_EMAIL}.")
}
}
+
}
diff --git a/offer-manager-domain/src/main/groovy/life/qbic/business/products/create/CreateProductDataSource.groovy b/offer-manager-domain/src/main/groovy/life/qbic/business/products/create/CreateProductDataSource.groovy
index 6ce0fa435..bc6fbfa8f 100644
--- a/offer-manager-domain/src/main/groovy/life/qbic/business/products/create/CreateProductDataSource.groovy
+++ b/offer-manager-domain/src/main/groovy/life/qbic/business/products/create/CreateProductDataSource.groovy
@@ -14,9 +14,11 @@ interface CreateProductDataSource {
/**
* Stores a product in the database
* @param product The product that needs to be stored
+ * @return The product identifier of the stored product
* @since 1.0.0
* @throws DatabaseQueryException if any technical interaction with the data source fails
* @throws ProductExistsException if the product already exists in the data source
*/
- void store(Product product) throws DatabaseQueryException, ProductExistsException
-}
\ No newline at end of file
+ ProductId store(Product product) throws DatabaseQueryException, ProductExistsException
+
+}
diff --git a/offer-manager-domain/src/test/groovy/life/qbic/business/products/archive/ArchiveProductSpec.groovy b/offer-manager-domain/src/test/groovy/life/qbic/business/products/archive/ArchiveProductSpec.groovy
index ea520a533..203ff7e30 100644
--- a/offer-manager-domain/src/test/groovy/life/qbic/business/products/archive/ArchiveProductSpec.groovy
+++ b/offer-manager-domain/src/test/groovy/life/qbic/business/products/archive/ArchiveProductSpec.groovy
@@ -7,9 +7,9 @@ import life.qbic.datamodel.dtos.business.services.ProductUnit
import spock.lang.Specification
/**
- * Archive Product tests
+ * {@kink ArchiveProduct} tests
*
- * This Specification contains tests for the use ArchiveProduct use case
+ * This Specification contains tests for the {@link ArchiveProduct} use case
*
* @since 1.0.0
*/
diff --git a/offer-manager-domain/src/test/groovy/life/qbic/business/products/copy/CopyProductSpec.groovy b/offer-manager-domain/src/test/groovy/life/qbic/business/products/copy/CopyProductSpec.groovy
new file mode 100644
index 000000000..a6b6491ae
--- /dev/null
+++ b/offer-manager-domain/src/test/groovy/life/qbic/business/products/copy/CopyProductSpec.groovy
@@ -0,0 +1,83 @@
+package life.qbic.business.products.copy
+
+import life.qbic.business.exceptions.DatabaseQueryException
+import life.qbic.business.products.create.CreateProduct
+import life.qbic.business.products.create.CreateProductDataSource
+import life.qbic.business.products.create.CreateProductInput
+import life.qbic.business.products.create.ProductExistsException
+import life.qbic.datamodel.dtos.business.ProductCategory
+import life.qbic.datamodel.dtos.business.ProductId
+import life.qbic.datamodel.dtos.business.services.AtomicProduct
+import life.qbic.datamodel.dtos.business.services.Product
+import life.qbic.datamodel.dtos.business.services.ProductUnit
+import life.qbic.datamodel.dtos.business.services.Sequencing
+import org.apache.tools.ant.taskdefs.Copy
+import spock.lang.IgnoreRest
+import spock.lang.Shared
+import spock.lang.Specification
+
+/**
+ * {@link CopyProduct} tests
+ *
+ * This Specification contains tests for the {@link CopyProduct} use case
+ *
+ * @since 1.0.0
+ */
+class CopyProductSpec extends Specification {
+
+
+ CreateProductDataSource createProductDataSource = Stub(CreateProductDataSource)
+ CopyProductDataSource dataSource = Stub(CopyProductDataSource)
+ CopyProductOutput output = Mock(CopyProductOutput)
+ Product product = new Sequencing("test product", "this is a test product", 0.5,
+ ProductUnit.PER_GIGABYTE,"1")
+
+ def "FailNotification forwards received messages to the output"() {
+ given: "a CreateProductDataSource that throws a DatabaseQueryException"
+ createProductDataSource.store(product) >> {throw new DatabaseQueryException("Test exception")}
+ and: "a copy use case with this datasource"
+ CopyProduct copyProduct = new CopyProduct(dataSource, output, createProductDataSource)
+
+ when: "copyModified is called"
+ copyProduct.copyModified(product)
+
+ then: "a fail notification is received in the output"
+ 1 * output.failNotification(_ as String)
+ and: "no output is registered"
+ 0 * output.copied(_)
+ noExceptionThrown()
+ }
+
+ def "A duplicated entry leads to fail notification"() {
+ given: "a CreateProductDataSource that throws a ProductExistsException"
+ createProductDataSource.store(product) >> {throw new ProductExistsException(product.getProductId(), "Test exception")}
+ and: "a copy use case with this datasource"
+ CopyProduct copyProduct = new CopyProduct(dataSource, output, createProductDataSource)
+
+ when: "copyModified is called"
+ copyProduct.copyModified(product)
+
+ then: "a fail notification is received in the output"
+ 1 * output.failNotification(_ as String)
+ and: "no other output is registered"
+ 0 * output.copied(_)
+ noExceptionThrown()
+ }
+
+ def "CopyModified rejects non existent products"() {
+ given: "A product that is not in the database"
+ dataSource.fetch(product.getProductId()) >> Optional.empty()
+ and: "a copy use case"
+ CopyProduct copyProduct = new CopyProduct(dataSource, output, createProductDataSource)
+
+ when: "copyModified is called with the unknown product"
+ copyProduct.copyModified(product)
+
+ then: "fail notification is created"
+ 1 * output.failNotification(_ as String)
+ and: "no other output is registered"
+ 0 * output.copied(_)
+ noExceptionThrown()
+ }
+
+}
diff --git a/offer-manager-domain/src/test/groovy/life/qbic/business/products/create/CreateProductSpec.groovy b/offer-manager-domain/src/test/groovy/life/qbic/business/products/create/CreateProductSpec.groovy
index 10acb195e..e52ba6e39 100644
--- a/offer-manager-domain/src/test/groovy/life/qbic/business/products/create/CreateProductSpec.groovy
+++ b/offer-manager-domain/src/test/groovy/life/qbic/business/products/create/CreateProductSpec.groovy
@@ -2,9 +2,9 @@ package life.qbic.business.products.create
import life.qbic.business.exceptions.DatabaseQueryException
import life.qbic.datamodel.dtos.business.ProductId
-import life.qbic.datamodel.dtos.business.services.AtomicProduct
import life.qbic.datamodel.dtos.business.services.Product
import life.qbic.datamodel.dtos.business.services.ProductUnit
+import life.qbic.datamodel.dtos.business.services.Sequencing
import spock.lang.Specification
/**
@@ -15,21 +15,16 @@ import spock.lang.Specification
* @since 1.0.0
*/
class CreateProductSpec extends Specification {
- CreateProductOutput output
- ProductId productId
- Product product
-
- def setup() {
- output = Mock(CreateProductOutput)
- productId = new ProductId("Test", "1234")
- product = new AtomicProduct("test product", "this is a test product", 0.5, ProductUnit.PER_GIGABYTE, productId)
- }
+ CreateProductOutput output = Mock(CreateProductOutput)
+ ProductId createdProductId = new ProductId("SE","2")
+ Product product = new Sequencing("test product", "this is a test product", 0.5, ProductUnit.PER_GIGABYTE, "1") //todo use long when ProductId builder is fixed
+
def "Create stores the provided product in the data source"() {
given: "a data source that stores a product"
CreateProductDataSource dataSource = Stub(CreateProductDataSource)
- String dataStatus = ""
- dataSource.store(product) >> { dataStatus = "stored" }
+ dataSource.store(product) >> { createdProductId }
+
and: "an instance of the use case"
CreateProduct createProduct = new CreateProduct(dataSource, output)
@@ -37,11 +32,28 @@ class CreateProductSpec extends Specification {
createProduct.create(product)
then: "the output is informed and no failure notification is send"
- 1 * output.created(product)
+ 1 * output.created({Product product1 ->
+ product1.productId == createdProductId
+ })
0 * output.foundDuplicate(_)
0 * output.failNotification(_)
- and: "the data was stored in the database"
- dataStatus == "stored"
+ }
+
+ def "Create sends a failure notification if the datasource returns null"() {
+ given: "a data source that stores a product"
+ CreateProductDataSource dataSource = Stub(CreateProductDataSource)
+ dataSource.store(product) >> { null }
+
+ and: "an instance of the use case"
+ CreateProduct createProduct = new CreateProduct(dataSource, output)
+
+ when: "the create method is called"
+ createProduct.create(product)
+
+ then: "the output is informed and no failure notification is send"
+ 0 * output.created(_)
+ 0 * output.foundDuplicate(_)
+ 1 * output.failNotification(_)
}
def "Create informs the output that an entry matching the provided product already exists"() {
@@ -50,9 +62,9 @@ class CreateProductSpec extends Specification {
String dataStatus = ""
dataSource.store(product) >> {
dataStatus = "not stored"
- println(dataStatus)
- throw new ProductExistsException(productId)
+ throw new ProductExistsException(createdProductId)
}
+
and: "an instance of the use case"
CreateProduct createProduct = new CreateProduct(dataSource, output)
@@ -74,6 +86,7 @@ class CreateProductSpec extends Specification {
dataSource.store(product) >> {
dataStatus = "not stored"
throw new DatabaseQueryException("This is a test") }
+
and: "an instance of the use case"
CreateProduct createProduct = new CreateProduct(dataSource, output)
@@ -87,4 +100,5 @@ class CreateProductSpec extends Specification {
and: "the data was stored"
dataStatus == "not stored"
}
+
}
diff --git a/pom.xml b/pom.xml
index e2fa503a9..51df5d8cd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -8,7 +8,7 @@
offer-manager-app
offer-manager
- 1.0.0-alpha.4
+ 1.0.0-alpha.5
life.qbic
The new offer manager
http://github.com/qbicsoftware/qOffer_2.0
@@ -119,7 +119,7 @@
life.qbic
data-model-lib
- 2.3.0
+ 2.5.0-SNAPSHOT
com.vaadin
diff --git a/qube.cfg b/qube.cfg
index 11a3da7f3..fe4a5ec55 100644
--- a/qube.cfg
+++ b/qube.cfg
@@ -1,5 +1,5 @@
[bumpversion]
-current_version = 1.0.0-SNAPSHOT
+current_version = 1.0.0-alpha.5
[bumpversion_files_whitelisted]
dot_qube = .qube.yml