Licence adjustments (#406)

* licence agreement

* missing licence files

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,18 +1,7 @@
-## Description
+## Why is this change proposed?
 
-Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+## Description of Changes
 
-Fixes #(issue)
+## Pull Request Contribution Terms
 
-## Type of change
-
-Please delete options that are not relevant.
-
-- Bug fix (non-breaking change which fixes an issue)
-- New feature (non-breaking change which adds functionality)
-- Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- This change requires a documentation update
-
-<!--
-By submitting this pull request, you agree to the contribution terms defined in [CONTRIBUTING.md](https://github.com/ecotoneframework/ecotone-dev/blob/main/CONTRIBUTING.md).
--->
+- [ ] I have read and agree to the contribution terms outlined in [CONTRIBUTING](https://github.com/ecotoneframework/ecotone-dev/blob/main/CONTRIBUTING.md).

.github/workflows/contribution-check.yml

@@ -0,0 +1,18 @@
+name: Check Contribution Terms Agreement
+
+on:
+  pull_request:
+    types: [opened, edited]
+
+jobs:
+  check-terms:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check for Contribution Agreement
+        uses: actions/github-script@v3
+        with:
+          script: |
+            const prBody = context.payload.pull_request.body;
+            if (!prBody.includes("[X] I have read and agree to the contribution terms")) {
+              core.setFailed("Contributor has not agreed to the contribution terms. Please mark the checkout with X to agree to the terms. `[X] I have read and agree to the contribution terms outlined in [CONTRIBUTING](https://github.com/ecotoneframework/ecotone-dev/blob/main/CONTRIBUTING.md)`");
+            }

.github/workflows/file-licence.yml

@@ -0,0 +1,28 @@
+name: Check Contribution Terms Agreement
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - '*.*'
+
+jobs:
+  check-files:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set Up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+
+      - name: Install dependencies
+        run: composer update --prefer-dist --no-interaction --ignore-platform-reqs
+
+      - name: Check for Contribution Files
+        shell: bash
+        run: |
+          php bin/check-licence.php

bin/add-licence.php → bin/add-apache-licence.php

@@ -7,13 +7,13 @@
 
 $finder = new \Symfony\Component\Finder\Finder();
 
-$files = $finder->files()->in(__DIR__ . "/../packages")->name("*.php");
+$files = $finder->files()->in(__DIR__ . "/../packages/*/src")->name("*.php");
 
 function addLicenceToFile(string $file)
 {
     $lines = file($file);
     foreach ($lines as $index => $line) {
-        if (preg_match('/^\s*(abstract class|final class|class|interface)\s+/', $line)) {
+        if (preg_match('/^\s*(abstract class|final class|class|interface|trait)\s+/', $line)) {
             array_splice($lines, $index, 0, [
                 <<<LICENCE
                 /**

bin/add-enterprise-licence.php

@@ -0,0 +1,37 @@
+<?php
+/*
+ * licence Apache-2.0
+ */
+
+require __DIR__ . "/../vendor/autoload.php";
+
+$finder = new \Symfony\Component\Finder\Finder();
+
+$files = $finder->files()->in(__DIR__ . "/../packages/*/src")->name("*.php");
+
+function addLicenceToFile(string $file)
+{
+    $lines = file($file);
+    foreach ($lines as $index => $line) {
+        if (preg_match('/^\s*(abstract class|final class|class|interface|trait)\s+/', $line)) {
+            array_splice($lines, $index, 0, [
+                <<<LICENCE
+                /**
+                 * licence Enterprise
+                 */
+                
+                LICENCE
+            ]);
+            break;
+        }
+    }
+    file_put_contents($file, implode('', $lines));
+}
+
+foreach ($files as $file) {
+    $fileContent = file_get_contents($file->getRealPath());
+
+    if (! preg_match('/\*\s*(@licence|licence)\s+(Enterprise|Apache\-2\.0)\s*/', $fileContent, $matches)) {
+        addLicenceToFile($file);
+    }
+}

bin/check-licence.php

@@ -0,0 +1,18 @@
+<?php
+/*
+ * licence Apache-2.0
+ */
+
+require __DIR__ . "/../vendor/autoload.php";
+
+$finder = new \Symfony\Component\Finder\Finder();
+
+$files = $finder->files()->in(__DIR__ . "/../packages/*/src")->name("*.php");
+
+foreach ($files as $file) {
+    $fileContent = file_get_contents($file->getRealPath());
+
+    if (! preg_match('/\*\s*(@licence|licence)\s+(Enterprise|Apache\-2\.0)\s*/', $fileContent, $matches)) {
+        throw new \RuntimeException("Missing licence in file: " . $file->getRealPath(). "\n. You can add related licence by triggering `bin/add-apache-licence.php` or if you are changing Enterprise modules `bin/add-enterprise-licence.php`");
+    }
+}

packages/Amqp/tests/Fixture/DistributedCommandBus/Receiver/Event/TicketCreated.php

@@ -4,6 +4,9 @@
 
 namespace Test\Ecotone\Amqp\Fixture\DistributedCommandBus\Receiver\Event;
 
+/**
+ * licence Apache-2.0
+ */
 final class TicketCreated
 {
     public function __construct(private string $ticket)

packages/Amqp/tests/Fixture/DistributedCommandBus/ReceiverEventHandler/TicketNotificationConfig.php

@@ -7,6 +7,9 @@
 use Ecotone\Amqp\AmqpBackedMessageChannelBuilder;
 use Ecotone\Messaging\Attribute\ServiceContext;
 
+/**
+ * licence Apache-2.0
+ */
 final class TicketNotificationConfig
 {
     #[ServiceContext]

packages/Amqp/tests/Fixture/DistributedCommandBus/ReceiverEventHandler/TicketNotificationEventHandler.php

@@ -9,6 +9,9 @@
 use Ecotone\Modelling\Attribute\QueryHandler;
 use Test\Ecotone\Amqp\Fixture\DistributedCommandBus\Receiver\Event\TicketCreated;
 
+/**
+ * licence Apache-2.0
+ */
 final class TicketNotificationEventHandler
 {
     public const GET_TICKETS_NOTIFICATION_COUNT      = 'getTicketsNotificationCount';

packages/Dbal/tests/Fixture/FailingConnection.php

@@ -15,6 +15,9 @@
 use Doctrine\DBAL\Statement;
 use Traversable;
 
+/**
+ * licence Apache-2.0
+ */
 final class FailingConnection extends Connection
 {
     /**

packages/Ecotone/src/Messaging/Handler/Processor/MethodInvoker/Pointcut/IncorrectPointcutException.php

@@ -6,6 +6,9 @@
 
 use Ecotone\Messaging\MessagingException;
 
+/**
+ * licence Apache-2.0
+ */
 final class IncorrectPointcutException extends MessagingException
 {
     protected static function errorCode(): int

packages/Ecotone/src/Modelling/WithAggregateEvents.php

@@ -11,6 +11,9 @@
  * @deprecated Use Ecotone\Modelling\WithEvents instead
  * @TODO Ecotone 2.0 replace with WithEvents
  */
+/**
+ * licence Apache-2.0
+ */
 trait WithAggregateEvents
 {
     private ?array $recordedEvents = null;

packages/Ecotone/src/Modelling/WithAggregateVersioning.php

@@ -4,6 +4,9 @@
 
 use Ecotone\Modelling\Attribute\AggregateVersion;
 
+/**
+ * licence Apache-2.0
+ */
 trait WithAggregateVersioning
 {
     #[AggregateVersion]

packages/Ecotone/src/Modelling/WithEvents.php

@@ -9,6 +9,9 @@
  * @package Ecotone\Modelling
  * @author Dariusz Gafka <support@simplycodedsoftware.com>
  */
+/**
+ * licence Apache-2.0
+ */
 trait WithEvents
 {
     private ?array $recordedEvents = null;

packages/Ecotone/tests/AnnotationFinder/Fixture/Usage/Attribute/Annotation/ParameterAttribute.php

@@ -5,6 +5,9 @@
 use Attribute;
 
 #[Attribute(Attribute::TARGET_PARAMETER)]
+/**
+ * licence Apache-2.0
+ */
 class ParameterAttribute
 {
 }

packages/Ecotone/tests/AnnotationFinder/Fixture/Usage/Attribute/Annotation/PropertyAttribute.php

@@ -5,6 +5,9 @@
 use Attribute;
 
 #[Attribute(Attribute::TARGET_PROPERTY)]
+/**
+ * licence Apache-2.0
+ */
 class PropertyAttribute
 {
 }

packages/Ecotone/tests/AnnotationFinder/Fixture/Usage/Attribute/TestingNamespace/Correct/ClassWithPromotedConstructorParameterAttribute.php

@@ -5,6 +5,9 @@
 use Test\Ecotone\AnnotationFinder\Fixture\Usage\Attribute\Annotation\ParameterAttribute;
 use Test\Ecotone\AnnotationFinder\Fixture\Usage\Attribute\Annotation\PropertyAttribute;
 
+/**
+ * licence Apache-2.0
+ */
 class ClassWithPromotedConstructorParameterAttribute
 {
     public function __construct(

packages/Ecotone/tests/AnnotationFinder/Unit/AttributeResolverTest.php

@@ -10,6 +10,9 @@
 /**
  * @internal
  */
+/**
+ * licence Apache-2.0
+ */
 class AttributeResolverTest extends TestCase
 {
     public function test_it_can_resolve_property_attributes_on_promoted_constructor_parameters(): void

packages/Ecotone/tests/Messaging/BaseEcotoneTestCase.php

@@ -9,6 +9,9 @@
 /**
  * @internal
  */
+/**
+ * licence Apache-2.0
+ */
 abstract class BaseEcotoneTestCase extends TestCase
 {
     /**

packages/Ecotone/tests/Messaging/Fixture/Channel/DynamicChannel/SimpleConsumptionDecider.php

@@ -8,6 +8,9 @@
 use Ecotone\Messaging\Attribute\Parameter\Header;
 use PHPUnit\Framework\Assert;
 
+/**
+ * licence Apache-2.0
+ */
 final class SimpleConsumptionDecider
 {
     public function __construct(private array $results, private string $expectedDynamicChannelName)

packages/Ecotone/tests/Messaging/Fixture/EnterpriseMode/EnterpriseClassInterface.php

@@ -7,6 +7,9 @@
 use Ecotone\Messaging\Attribute\Enterprise;
 
 #[Enterprise]
+/**
+ * licence Apache-2.0
+ */
 class EnterpriseClassInterface
 {
     public function execute(): void

packages/Ecotone/tests/Messaging/Fixture/EnterpriseMode/EnterpriseMethodInterface.php

@@ -6,6 +6,9 @@
 
 use Ecotone\Messaging\Attribute\Enterprise;
 
+/**
+ * licence Apache-2.0
+ */
 class EnterpriseMethodInterface
 {
     #[Enterprise]

packages/Ecotone/tests/Messaging/Fixture/EnterpriseMode/StandardInterface.php

@@ -4,6 +4,9 @@
 
 namespace Test\Ecotone\Messaging\Fixture\EnterpriseMode;
 
+/**
+ * licence Apache-2.0
+ */
 class StandardInterface
 {
     public function execute(): void

packages/Ecotone/tests/Messaging/Fixture/InterceptorsOrdering/CreatedEvent.php

@@ -2,6 +2,9 @@
 
 namespace Test\Ecotone\Messaging\Fixture\InterceptorsOrdering;
 
+/**
+ * licence Apache-2.0
+ */
 class CreatedEvent
 {
 }

packages/Ecotone/tests/Messaging/Fixture/InterceptorsOrdering/Gateway.php

@@ -4,6 +4,9 @@
 
 use Ecotone\Messaging\Attribute\MessageGateway;
 
+/**
+ * licence Apache-2.0
+ */
 interface Gateway
 {
     #[MessageGateway(requestChannel: 'serviceEndpointReturning')]

packages/Ecotone/tests/Messaging/Fixture/InterceptorsOrdering/GatewayInterceptors.php

@@ -8,6 +8,9 @@
 use Ecotone\Messaging\Attribute\Parameter\Reference;
 use Ecotone\Messaging\Handler\Processor\MethodInvoker\MethodInvocation;
 
+/**
+ * licence Apache-2.0
+ */
 class GatewayInterceptors
 {
     #[Around(pointcut: Gateway::class)]

packages/Ecotone/tests/Messaging/Fixture/InterceptorsOrdering/InterceptorOrderingAggregate.php

@@ -9,6 +9,9 @@
 use Ecotone\Modelling\WithEvents;
 
 #[Aggregate]
+/**
+ * licence Apache-2.0
+ */
 class InterceptorOrderingAggregate
 {
     use WithEvents;

packages/Ecotone/tests/Messaging/Fixture/InterceptorsOrdering/InterceptorOrderingCase.php

@@ -7,6 +7,9 @@
 use Ecotone\Messaging\Attribute\ServiceActivator;
 use Ecotone\Modelling\Attribute\CommandHandler;
 
+/**
+ * licence Apache-2.0
+ */
 class InterceptorOrderingCase
 {
     #[CommandHandler(routingKey: 'commandEndpointReturning')]

packages/Ecotone/tests/Messaging/Fixture/InterceptorsOrdering/InterceptorOrderingInterceptors.php

@@ -10,6 +10,9 @@
 use Ecotone\Messaging\Handler\Processor\MethodInvoker\MethodInvocation;
 use Ecotone\Modelling\Attribute\EventHandler;
 
+/**
+ * licence Apache-2.0
+ */
 class InterceptorOrderingInterceptors
 {
     #[After(precedence: -1, pointcut: InterceptorOrderingAggregate::class . '||' . InterceptorOrderingCase::class, changeHeaders: true)]

packages/Ecotone/tests/Messaging/Fixture/InterceptorsOrdering/InterceptorOrderingStack.php

@@ -2,6 +2,9 @@
 
 namespace Test\Ecotone\Messaging\Fixture\InterceptorsOrdering;
 
+/**
+ * licence Apache-2.0
+ */
 class InterceptorOrderingStack
 {
     private array $calls = [];

packages/Ecotone/tests/Messaging/Fixture/InterceptorsOrdering/OutputHandler.php

@@ -7,6 +7,9 @@
 use Ecotone\Messaging\Attribute\InternalHandler;
 use Ecotone\Messaging\Attribute\Parameter\Reference;
 
+/**
+ * licence Apache-2.0
+ */
 final class OutputHandler
 {
     #[InternalHandler(inputChannelName: 'internal-channel')]