Merge pull request #18 from paragonie/ga

Travis CI -> Github Actions
paragonie · Apr 17, 2021 · bae5f15 · bae5f15
2 parents aefe70b + e143ea3
commit bae5f15
Show file tree

Hide file tree

Showing 16 changed files with 137 additions and 39 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,96 @@
+name: CI
+
+on: [push]
+
+jobs:
+  old:
+    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: ['ubuntu-16.04']
+        php-versions: ['7.0']
+        phpunit-versions: ['7.5.20']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: mbstring, intl
+          ini-values: post_max_size=256M, max_execution_time=180
+          tools: psalm, phpunit:${{ matrix.phpunit-versions }}
+
+      - name: Install dependencies
+        run: composer self-update --1; composer install
+
+      - name: PHPUnit tests
+        uses: php-actions/phpunit@v2
+        with:
+          memory_limit: 256M
+
+  moderate:
+    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: ['ubuntu-latest']
+        php-versions: ['7.1', '7.2', '7.3']
+        phpunit-versions: ['latest']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: mbstring, intl, sodium
+          ini-values: post_max_size=256M, max_execution_time=180
+          tools: psalm, phpunit:${{ matrix.phpunit-versions }}
+
+      - name: Install dependencies
+        run: composer install
+
+      - name: PHPUnit tests
+        uses: php-actions/phpunit@v2
+        timeout-minutes: 30
+        with:
+          memory_limit: 256M
+
+  modern:
+    name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: ['ubuntu-latest']
+        php-versions: ['7.4', '8.0']
+        phpunit-versions: ['latest']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: mbstring, intl, sodium
+          ini-values: post_max_size=256M, max_execution_time=180
+          tools: psalm, phpunit:${{ matrix.phpunit-versions }}
+
+      - name: Install dependencies
+        run: composer install
+
+      - name: PHPUnit tests
+        uses: php-actions/phpunit@v2
+        timeout-minutes: 30
+        with:
+          memory_limit: 256M
+
+      - name: Install Psalm
+        run: composer require --dev vimeo/psalm:^4
+
+      - name: Static Analysis
+        run: vendor/bin/psalm
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Sapient: Secure API toolkit
 
-[![Build Status](https://travis-ci.org/paragonie/sapient.svg?branch=master)](https://travis-ci.org/paragonie/sapient)
+[![Build Status](https://github.com/paragonie/sapient/actions/workflows/ci.yml/badge.svg)](https://github.com/sapient/actions)
 [![Latest Stable Version](https://poser.pugx.org/paragonie/sapient/v/stable)](https://packagist.org/packages/paragonie/sapient)
 [![Latest Unstable Version](https://poser.pugx.org/paragonie/sapient/v/unstable)](https://packagist.org/packages/paragonie/sapient)
 [![License](https://poser.pugx.org/paragonie/sapient/license)](https://packagist.org/packages/paragonie/sapient)

diff --git a/composer.json b/composer.json
@@ -6,13 +6,13 @@
     "php": "^7|^8",
     "guzzlehttp/psr7": "^1",
     "paragonie/constant_time_encoding": "^2",
-    "paragonie/sodium_compat": "^1",
+    "paragonie/sodium_compat": ">= 1.15.4",
     "psr/http-message": "^1"
   },
   "require-dev": {
-    "guzzlehttp/guzzle": "^6",
-    "phpunit/phpunit": "^6|^7",
-    "vimeo/psalm": "^2|^3"
+    "guzzlehttp/guzzle": "^6|^7",
+    "phpunit/phpunit": "^6|^7|^8|^9",
+    "vimeo/psalm": "^2|^3|^4"
   },
   "suggest": {
     "guzzlehttp/guzzle": ">= 6.0 -- Sapient can be used a Guzzle adapter"

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
     backupGlobals="true"
-    bootstrap="vendor/autoload.php"
+    bootstrap="phpunit-autoload.php"
     colors="true"
     convertErrorsToExceptions="true"
     convertNoticesToExceptions="true"

diff --git a/psalm.xml b/psalm.xml
@@ -1,13 +1,27 @@
 <?xml version="1.0"?>
 <psalm
+    autoloader="phpunit-autoload.php"
     useDocblockTypes="true"
     totallyTyped="true"
 >
     <projectFiles>
         <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
     </projectFiles>
     <issueHandlers>
+        <MoreSpecificImplementedParamType errorLevel="suppress" /><!-- this is fine -->
+        <RedundantConditionGivenDocblockType errorLevel="suppress" /><!-- we're being explicit -->
+        <RedundantCastGivenDocblockType errorLevel="suppress" /><!-- we're being explicit -->
+        <DocblockTypeContradiction errorLevel="info" /><!-- We're still supporting PHP 5 -->
+        <UnnecessaryVarAnnotation errorLevel="suppress" />
+        <UnusedFunctionCall errorLevel="info" />
+        <UnusedVariable errorLevel="info" />
+        <RedundantCast errorLevel="suppress" />
+        <MixedReturnTypeCoercion errorLevel="info" />
         <InternalMethod errorLevel="suppress" />
         <RedundantConditionGivenDocblockType errorLevel="info" />
+        <UnsafeInstantiation errorLevel="info" />
     </issueHandlers>
 </psalm>
diff --git a/src/Adapter/Generic/Stream.php b/src/Adapter/Generic/Stream.php
@@ -39,7 +39,7 @@ class Stream implements StreamInterface
     /**
      * The underlying stream resource
      *
-     * @var resource|null
+     * @var resource|closed-resource|null
      */
     protected $stream;
 

diff --git a/src/Adapter/Guzzle.php b/src/Adapter/Guzzle.php
@@ -582,6 +582,8 @@ public function getGuzzleClient(): Client
      * @param string $input
      * @return StreamInterface
      * @throws \TypeError
+     *
+     * @psalm-suppress DeprecatedFunction
      */
     public function stringToStream(string $input): StreamInterface
     {

diff --git a/src/CryptographyKeys/SealingSecretKey.php b/src/CryptographyKeys/SealingSecretKey.php
@@ -50,15 +50,17 @@ public function deriveSharedEncryptionkey(
                 $this->getString(true),
                 $publicKey->getString(true),
                 $publicKey->getString(true),
-                $this->getPublickey()->getString(true)
+                $this->getPublickey()->getString(true),
+                true
             );
         } else {
             // You are the client:
             $shared = \ParagonIE_Sodium_Compat::crypto_kx(
                 $this->getString(true),
                 $publicKey->getString(true),
                 $this->getPublickey()->getString(true),
-                $publicKey->getString(true)
+                $publicKey->getString(true),
+                true
             );
         }
         return new SharedEncryptionKey($shared);

diff --git a/tests/Adapter/GenericTest.php b/tests/Adapter/GenericTest.php
@@ -11,8 +11,9 @@ class GenericTest extends TestCase
     protected $adapter;
     /**
      * Populate the methods.
+     * @before
      */
-    public function setup()
+    public function before()
     {
         $this->adapter = new Adapter();
     }

diff --git a/tests/Adapter/GuzzleTest.php b/tests/Adapter/GuzzleTest.php
@@ -53,8 +53,9 @@ class GuzzleTest extends TestCase
 
     /**
      * Populate the methods.
+     * @before
      */
-    public function setup()
+    public function before()
     {
         if (!\class_exists('GuzzleHttp\Client')) {
             $this->markTestSkipped('Guzzle not included as a dependency.');

diff --git a/tests/KeyExchangeTest.php b/tests/KeyExchangeTest.php
@@ -27,8 +27,9 @@ class KeyExchangeTest extends TestCase
 
     /**
      * Setup the class properties
+     * @before
      */
-    public function setUp()
+    public function before()
     {
         $this->clientSealSecret = SealingSecretKey::generate();
         $this->clientSealPublic = $this->clientSealSecret->getPublickey();

diff --git a/tests/SapientAuthenticateTest.php b/tests/SapientAuthenticateTest.php
@@ -26,8 +26,9 @@ class SapientAuthenticateTest extends TestCase
 
     /**
      * Setup the class properties
+     * @before
      */
-    public function setUp()
+    public function before()
     {
         $this->sapient = new Sapient(new Guzzle());
 

diff --git a/tests/SapientSealTest.php b/tests/SapientSealTest.php
@@ -35,8 +35,9 @@ class SapientSealTest extends TestCase
 
     /**
      * Setup the class properties
+     * @before
      */
-    public function setUp()
+    public function before()
     {
         $this->sapient = new Sapient(new Guzzle());
 

diff --git a/tests/SapientSignTest.php b/tests/SapientSignTest.php
@@ -37,8 +37,9 @@ class SapientSignTest extends TestCase
 
     /**
      * Setup the class properties
+     * @before
      */
-    public function setUp()
+    public function before()
     {
         $this->sapient = new Sapient(new Guzzle());
 

diff --git a/tests/SapientSymmetricTest.php b/tests/SapientSymmetricTest.php
@@ -52,8 +52,9 @@ private function getSampleObjects(): array
 
     /**
      * Setup the class properties
+     * @before
      */
-    public function setUp()
+    public function before()
     {
         $this->sapient = new Sapient(new Guzzle());
         $this->sharedEncryptionKey = SharedEncryptionKey::generate();