incorporate vfsStreams

Author: smaddock

src/ResourceDetectors/DigitalOcean/.phan/config.php

@@ -42,7 +42,7 @@
     //
     // Note that the **only** effect of choosing `'5.6'` is to infer that functions removed in php 7.0 exist.
     // (See `backward_compatibility_checks` for additional options)
-    'target_php_version' => '8.0',
+    'target_php_version' => '8.1',
 
     // If enabled, missing properties will be created when
     // they are first seen. If false, we'll report an

src/ResourceDetectors/DigitalOcean/composer.json

@@ -20,6 +20,7 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.54",
+        "mikey179/vfsstream": "^1.6.11",
         "nyholm/psr7": "*",
         "phan/phan": "^5.4",
         "phpstan/phpstan": "^1.10.13",

src/ResourceDetectors/DigitalOcean/src/DigitalOceanDetector.php

@@ -30,14 +30,18 @@ final class DigitalOceanDetector implements ResourceDetectorInterface
     private const DO_PUBLIC_ENDPOINT_URL = 'https://api.digitalocean.com/v2/';
     private const ENV_DO_API_TOKEN = 'DIGITALOCEAN_ACCESS_TOKEN';
 
+    public function __construct(private readonly string $rootPath = '/')
+    {
+    }
+
     public function getResource(): ResourceInfo
     {
         $client = Discovery::find();
         $requestFactory = MessageFactoryResolver::create()->resolveRequestFactory();
         $token = $_SERVER[self::ENV_DO_API_TOKEN] ?? '';
 
         /** Bail early if wrong environment */
-        if (!self::isDigitalOcean()) {
+        if (!$this->isDigitalOcean()) {
             self::logNotice('DigitalOcean resource detector enabled in non-DigitalOcean environment');
 
             return ResourceInfoFactory::emptyResource();
@@ -46,10 +50,10 @@ public function getResource(): ResourceInfo
         try {
             /** Attributes available locally - all non-privileged lookups */
             $attributes = [
-                ResourceAttributes::CLOUD_PLATFORM => self::readSMBIOS('product_family'),
-                ResourceAttributes::CLOUD_PROVIDER => self::readSMBIOS('sys_vendor'),
+                ResourceAttributes::CLOUD_PLATFORM => $this->readSMBIOS('product_family'),
+                ResourceAttributes::CLOUD_PROVIDER => $this->readSMBIOS('sys_vendor'),
                 ResourceAttributes::HOST_ARCH => ResourceAttributeValues::HOST_ARCH_AMD64,
-                ResourceAttributes::HOST_ID => self::readSMBIOS('board_asset_tag'),
+                ResourceAttributes::HOST_ID => $this->readSMBIOS('board_asset_tag'),
                 ResourceAttributes::HOST_NAME => gethostname(),
                 ResourceAttributes::OS_TYPE => ResourceAttributeValues::OS_TYPE_LINUX,
             ];
@@ -118,10 +122,10 @@ public function getResource(): ResourceInfo
         return ResourceInfo::create(Attributes::create($attributes), ResourceAttributes::SCHEMA_URL);
     }
 
-    private static function isDigitalOcean(): bool
+    private function isDigitalOcean(): bool
     {
         try {
-            $sysVendor = self::readSMBIOS('sys_vendor');
+            $sysVendor = $this->readSMBIOS('sys_vendor');
         } catch (UnexpectedValueException) {
             return false;
         }
@@ -132,9 +136,9 @@ private static function isDigitalOcean(): bool
         return true;
     }
 
-    private static function readSMBIOS(string $dmiKeyword): string
+    private function readSMBIOS(string $dmiKeyword): string
     {
-        $dmiValue = file_get_contents(sprintf('/sys/devices/virtual/dmi/id/%s', $dmiKeyword));
+        $dmiValue = file_get_contents(sprintf('%ssys/devices/virtual/dmi/id/%s', $this->rootPath, $dmiKeyword));
         if ($dmiValue === false) {
             throw new UnexpectedValueException('Failed to read SMBIOS value from sysfs.');
         }

src/ResourceDetectors/DigitalOcean/tests/Unit/DigitalOceanDetectorTest.php

@@ -13,28 +13,13 @@
 use OpenTelemetry\SDK\Resource\ResourceInfoFactory;
 use OpenTelemetry\SemConv\ResourceAttributes;
 use OpenTelemetry\SemConv\ResourceAttributeValues;
+use org\bovigo\vfs\vfsStream;
+use org\bovigo\vfs\vfsStreamDirectory;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\RequestInterface;
 use Zalas\PHPUnit\Globals\Attribute\Server;
 
-function file_get_contents(string $filename)
-{
-    if (($_SERVER['FAIL_IO'] ?? 'false') === 'true') {
-        return false;
-    }
-    if (str_starts_with($filename, '/sys/devices/virtual/dmi/id')) {
-        return match (substr($filename, 28)) {
-            'sys_vendor' => (($_SERVER['WRONG_VENDOR'] ?? 'false') === 'true') ? 'AWS' : 'DigitalOcean',
-            'product_family' => 'DigitalOcean_Droplet',
-            'board_asset_tag' => '10000000',
-            default => 'unknown'
-        };
-    }
-
-    return \file_get_contents($filename);
-}
-
 function gethostname()
 {
     return 'test-server';
@@ -44,21 +29,37 @@ function gethostname()
 class DigitalOceanDetectorTest extends TestCase
 {
     private mixed $errorLog;
+    private vfsStreamDirectory $vfs;
 
     public function setUp(): void
     {
+        /** mock sysfs with DigitalOcean SMBIOS pointers */
+        $this->vfs = vfsStream::setup('/', structure: [
+            'sys' => [
+                'devices' => [
+                    'virtual' => [
+                        'dmi' => [
+                            'id' => [
+                                'board_asset_tag' => '10000000',
+                                'product_family' => 'DigitalOcean_Droplet',
+                                'sys_vendor' => 'DigitalOcean',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+        ]);
+
+        /** mock stdout for `error_log` */
         $this->errorLog = tmpfile();
         /** @psalm-suppress PossiblyFalseArgument */
         ini_set('error_log', stream_get_meta_data($this->errorLog)['uri']);
 
+        /** mock HTTP client and DigitalOcean API responses */
         $responseFactory = MessageFactoryResolver::create()->resolveResponseFactory();
         $client = $this->createStub(Psr18Client::class);
         $client->method('sendRequest')->willReturnCallback(function (RequestInterface $request) use ($responseFactory) {
             if ((string) $request->getUri() === 'http://169.254.169.254/metadata/v1.json') {
-                if (($_SERVER['FAIL_METADATA'] ?? 'false') === 'true') {
-                    return $responseFactory->createResponse(500);
-                }
-
                 /** @psalm-suppress PossiblyFalseArgument */
                 return $responseFactory->createResponse()->withBody(
                     Stream::create(file_get_contents(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'mock-metadata.json'))
@@ -102,7 +103,7 @@ public function test_droplet_attributes_with_no_authz()
                 ResourceAttributes::HOST_NAME => 'test-server',
                 ResourceAttributes::OS_TYPE => ResourceAttributeValues::OS_TYPE_LINUX,
             ]),
-            (new DigitalOceanDetector())->getResource()->getAttributes()
+            (new DigitalOceanDetector($this->vfs->url()))->getResource()->getAttributes()
         );
     }
 
@@ -121,7 +122,7 @@ public function test_droplet_attributes_with_account_only_authz()
                 ResourceAttributes::HOST_NAME => 'test-server',
                 ResourceAttributes::OS_TYPE => ResourceAttributeValues::OS_TYPE_LINUX,
             ]),
-            (new DigitalOceanDetector())->getResource()->getAttributes()
+            (new DigitalOceanDetector($this->vfs->url()))->getResource()->getAttributes()
         );
         /** @psalm-suppress PossiblyFalseArgument */
         $this->assertStringContainsString(
@@ -148,7 +149,7 @@ public function test_droplet_attributes_with_droplet_only_authz()
                 ResourceAttributes::HOST_TYPE => 's-1vcpu-1gb',
                 ResourceAttributes::OS_NAME => 'Debian',
             ]),
-            (new DigitalOceanDetector())->getResource()->getAttributes()
+            (new DigitalOceanDetector($this->vfs->url()))->getResource()->getAttributes()
         );
         /** @psalm-suppress PossiblyFalseArgument */
         $this->assertStringContainsString(
@@ -157,12 +158,23 @@ public function test_droplet_attributes_with_droplet_only_authz()
         );
     }
 
-    #[Server('FAIL_METADATA', 'true')]
     public function test_no_droplet_attributes()
     {
+        /** mock HTTP client and with failing response */
+        $client = $this->createStub(Psr18Client::class);
+        $client->method('sendRequest')->willReturnCallback(function () {
+            $responseFactory = MessageFactoryResolver::create()->resolveResponseFactory();
+
+            return $responseFactory->createResponse(500);
+        });
+        $clientDiscoverer = $this->createStub(DiscoveryInterface::class);
+        $clientDiscoverer->method('available')->willReturn(true);
+        $clientDiscoverer->method('create')->willReturn($client);
+        Discovery::setDiscoverers([$clientDiscoverer]);
+
         $this->assertEquals(
             ResourceInfoFactory::emptyResource(),
-            (new DigitalOceanDetector())->getResource()
+            (new DigitalOceanDetector($this->vfs->url()))->getResource()
         );
         /** @psalm-suppress PossiblyFalseArgument */
         $this->assertStringContainsString(
@@ -171,12 +183,16 @@ public function test_no_droplet_attributes()
         );
     }
 
-    #[Server('WRONG_VENDOR', 'true')]
     public function test_not_digitalocean_environment()
     {
+        /** mock sysfs with AWS SMBIOS pointers */
+        $vfs = vfsStream::setup('/', structure: ['sys' => ['devices' => ['virtual' => ['dmi' => ['id' => [
+            'sys_vendor' => 'AWS',
+        ]]]]]]);
+
         $this->assertEquals(
             ResourceInfoFactory::emptyResource(),
-            (new DigitalOceanDetector())->getResource()
+            (new DigitalOceanDetector($vfs->url()))->getResource()
         );
         /** @psalm-suppress PossiblyFalseArgument */
         $this->assertStringContainsString(
@@ -185,12 +201,14 @@ public function test_not_digitalocean_environment()
         );
     }
 
-    #[Server('FAIL_IO', 'true')]
     public function test_not_linux()
     {
+        /** mock sysfs with no SMBIOS pointers */
+        $vfs = vfsStream::setup('/');
+
         $this->assertEquals(
             ResourceInfoFactory::emptyResource(),
-            (new DigitalOceanDetector())->getResource()
+            (new DigitalOceanDetector($vfs->url()))->getResource()
         );
         /** @psalm-suppress PossiblyFalseArgument */
         $this->assertStringContainsString(