#1409 - SFTP

.codecov.yaml

@@ -83,6 +83,10 @@ component_management:
       name: bridge-filesystem-azure
       paths:
         - src/bridge/filesystem/azure/**
+    - component_id: bridge-filesystem-sftp
+      name: bridge-filesystem-sftp
+      paths:
+        - src/bridge/filesystem/sftp/**
     - component_id: bridge-monolog-http
       name: bridge-monolog-http
       paths:

.env.dist

@@ -7,6 +7,10 @@ S3_REGION=us-east-1
 S3_ACCESS_KEY_ID=minioadmin
 S3_SECRET_ACCESS_KEY=minioadmin
 S3_BUCKET=flowphpbucket01
+SFTP_HOST=localhost
+SFTP_PORT=2222
+SFTP_USER=flow
+SFTP_PASSWORD=flow
 REDIS_HOST=localhost
 REDIS_PORT=6379
 PGSQL_DATABASE_URL=pgsql://postgres:postgres@127.0.0.1:5432/postgres?serverVersion=18&charset=utf8

.github/workflows/job-tests.yml

@@ -95,6 +95,14 @@ jobs:
             mc mb local/flowphpbucket01 --ignore-existing
           "
 
+      - name: "Start SFTP server"
+        run: |
+          docker run -d --name sftp -p 2222:22 \
+            -v ${{ github.workspace }}/docker/sftp.json:/app/config/sftp.json:ro \
+            emberstack/sftp:latest
+          timeout 60 sh -c 'until nc -z localhost 2222; do sleep 1; done'
+          echo "SFTP is ready"
+
       - name: "Setup PHP Environment"
         uses: "./.github/actions/setup-php-env"
         with:
@@ -148,6 +156,10 @@ jobs:
           S3_REGION: "us-east-1"
           S3_ACCESS_KEY_ID: "minioadmin"
           S3_SECRET_ACCESS_KEY: "minioadmin"
+          SFTP_HOST: "localhost"
+          SFTP_PORT: "2222"
+          SFTP_USER: "flow"
+          SFTP_PASSWORD: "flow"
           OTEL_RECEIVER_HTTP_ENDPOINT: "http://localhost:4318"
           OTEL_RECEIVER_GRPC_ENDPOINT: "localhost:4317"
           OTEL_COLLECTOR_METRICS_ENDPOINT: "http://localhost:8888/metrics"

.github/workflows/monorepo-split.yml

@@ -83,6 +83,8 @@ jobs:
             split_repository: 'filesystem-azure-bridge'
           - local_path: 'src/bridge/filesystem/async-aws'
             split_repository: 'filesystem-async-aws-bridge'
+          - local_path: 'src/bridge/filesystem/sftp'
+            split_repository: 'filesystem-sftp-bridge'
           - local_path: 'src/bridge/monolog/http'
             split_repository: 'monolog-http-bridge'
           - local_path: 'src/bridge/monolog/telemetry'

bin/docs.php

@@ -83,6 +83,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
             __DIR__ . '/../src/lib/azure-sdk/src/Flow/Azure/SDK/DSL/functions.php',
             __DIR__ . '/../src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/DSL/functions.php',
             __DIR__ . '/../src/bridge/filesystem/async-aws/src/Flow/Filesystem/Bridge/AsyncAWS/DSL/functions.php',
+            __DIR__ . '/../src/bridge/filesystem/sftp/src/Flow/Filesystem/Bridge/SFTP/DSL/functions.php',
             __DIR__ . '/../src/bridge/monolog/telemetry/src/Flow/Bridge/Monolog/Telemetry/DSL/functions.php',
             __DIR__
                 . '/../src/bridge/symfony/http-foundation-telemetry/src/Flow/Bridge/Symfony/HttpFoundationTelemetry/DSL/functions.php',

compose.yml.dist

@@ -87,6 +87,15 @@ services:
             "
         networks:
             - flow-php
+    sftp:
+        image: emberstack/sftp:latest
+        container_name: flow-php-sftp
+        ports:
+            - "2222:22"
+        volumes:
+            - "./docker/sftp.json:/app/config/sftp.json:ro"
+        networks:
+            - flow-php
     aspire:
         image: mcr.microsoft.com/dotnet/aspire-dashboard:latest
         container_name: flow-php-aspire

composer.json

@@ -34,6 +34,7 @@
         "openspout/openspout": "^5.2",
         "packaged/thrift": "^0.15.0",
         "php-http/discovery": "^1.0",
+        "phpseclib/phpseclib": "^3.0",
         "psr/clock": "^1.0",
         "psr/http-client": "^1.0",
         "psr/http-factory": "^1.0",
@@ -115,6 +116,7 @@
         "flow-php/filesystem": "self.version",
         "flow-php/filesystem-async-aws-bridge": "self.version",
         "flow-php/filesystem-azure-bridge": "self.version",
+        "flow-php/filesystem-sftp-bridge": "self.version",
         "flow-php/filesytem-async-aws-bridge": "self.version",
         "flow-php/filesytem-azure-bridge": "self.version",
         "flow-php/monolog-http-bridge": "self.version",
@@ -166,6 +168,7 @@
                 "src/adapter/etl-adapter-xml/src/Flow",
                 "src/bridge/filesystem/async-aws/src/Flow",
                 "src/bridge/filesystem/azure/src/Flow",
+                "src/bridge/filesystem/sftp/src/Flow",
                 "src/bridge/monolog/http/src/Flow",
                 "src/bridge/monolog/telemetry/src/Flow",
                 "src/bridge/openapi/specification/src/Flow",
@@ -232,6 +235,7 @@
             "src/adapter/etl-adapter-xml/src/Flow/ETL/Adapter/XML/functions.php",
             "src/bridge/filesystem/async-aws/src/Flow/Filesystem/Bridge/AsyncAWS/DSL/functions.php",
             "src/bridge/filesystem/azure/src/Flow/Filesystem/Bridge/Azure/DSL/functions.php",
+            "src/bridge/filesystem/sftp/src/Flow/Filesystem/Bridge/SFTP/DSL/functions.php",
             "src/bridge/monolog/http/src/Flow/Bridge/Monolog/Http/DSL/functions.php",
             "src/bridge/monolog/telemetry/src/Flow/Bridge/Monolog/Telemetry/DSL/functions.php",
             "src/bridge/phpunit/postgresql/src/Flow/Bridge/PHPUnit/PostgreSQL/DSL/functions.php",
@@ -287,6 +291,7 @@
                 "src/adapter/etl-adapter-xml/tests/Flow",
                 "src/bridge/filesystem/async-aws/tests/Flow",
                 "src/bridge/filesystem/azure/tests/Flow",
+                "src/bridge/filesystem/sftp/tests/Flow",
                 "src/bridge/monolog/http/tests/Flow",
                 "src/bridge/monolog/telemetry/tests/Flow",
                 "src/bridge/openapi/specification/tests/Flow",

docker/sftp.json

@@ -0,0 +1,16 @@
+{
+    "Global": {
+        "Chroot": {
+            "Directory": "%h",
+            "StartPath": "upload"
+        },
+        "Directories": ["upload"]
+    },
+    "Users": [
+        {
+            "Username": "flow",
+            "Password": "flow",
+            "UID": 1001
+        }
+    ]
+}