[IM] Allow an infrastructure to be excluded from IX-F Export - fixes #788

barryo · barryo · commit 69c09ffb7d02 · 2025-11-11T09:16:40.000Z
diff --git a/app/Http/Controllers/InfrastructureController.php b/app/Http/Controllers/InfrastructureController.php
@@ -102,6 +102,10 @@ public function feInit(): void
                     'title' => 'Country',
                     'type' => self::$FE_COL_TYPES[ 'COUNTRY' ]
                 ],
+                'exclude_from_ixf_export' => [
+                    'title' => 'Exclude from IX-F Export',
+                    'type' => self::$FE_COL_TYPES[ 'YES_NO' ]
+                ],
                 'notes'       => [
                     'title'         => 'Notes',
                     'type'          => self::$FE_COL_TYPES[ 'PARSDOWN' ]
@@ -171,7 +175,9 @@ protected function editPrepareForm( int $id ): array
             'shortname'        => request()->old( 'shortname', $this->object->shortname     ),
             'isPrimary'        => request()->old( 'isPrimary', $this->object->isPrimary     ),
             'country'          => request()->old( 'country', in_array( $this->object->country,  array_values( Countries::getListForSelect( 'iso_3166_2' ) ), false ) ? $this->object->country : null ),
-            'notes'            => request()->old( 'notes', $this->object->notes             ),
+            'exclude_from_ixf_export'
+                               => request()->old( 'exclude_from_ixf_export', $this->object->exclude_from_ixf_export  ),
+            'notes'            => request()->old( 'notes',                   $this->object->notes                    ),
         ]);
 
         return [
diff --git a/app/Models/Infrastructure.php b/app/Models/Infrastructure.php
@@ -67,6 +67,8 @@
  * @property int $ixp_id
  * @method static Builder|Infrastructure whereIxpId($value)
  * @property-read Collection<int, \IXP\Models\Vlan> $vlans
+ * @property int $exclude_from_ixf_export
+ * @method static Builder<static>|Infrastructure whereExcludeFromIxfExport($value)
  * @mixin Eloquent
  */
 class Infrastructure extends Model
@@ -90,6 +92,7 @@ class Infrastructure extends Model
         'name',
         'shortname',
         'isPrimary',
+        'exclude_from_ixf_export',
         'peeringdb_ix_id',
         'ixf_ix_id',
         'country',
diff --git a/app/Utils/Export/JsonSchema.php b/app/Utils/Export/JsonSchema.php
@@ -71,6 +71,9 @@ class JsonSchema
         self::EUROIX_JSON_VERSION_1_0,
     ];
     
+    // the data to export
+    private array $output = [];
+    
     /**
      * Get the JSON schema (for a given version or for the latest version)
      *
@@ -90,26 +93,26 @@ public function get( ?string $version = null, bool $asArray = false, bool $detai
         }
 
         /** @psalm-suppress UndefinedConstant */
-        $output = [
+        $this->output = [
             'version' => $version,
             'generator' => 'IXP Manager v' . APPLICATION_VERSION,
         ];
 
         // normalise times to UTC for exports
         date_default_timezone_set('UTC');
-        $output['timestamp'] = now()->toIso8601ZuluString();
+        $this->output['timestamp'] = now()->toIso8601ZuluString();
 
-        $output['ixp_list']    = $this->getIXPInfo( $version );
-        $output['member_list'] = $this->getMemberInfo( $version, $detailed, $tags );
+        $infrasIncluded = $this->getIXPInfo( $version );
+        $this->output['member_list'] = $this->getMemberInfo( $version, $detailed, $tags, $infrasIncluded );
 
         // apply filters as some IXs don't want to export all details
-        $output = $this->filter($output);
+        $this->output = $this->filter($this->output);
 
         if( $asArray ) {
-            return $output;
+            return $this->output;
         }
 
-        return json_encode( $output, JSON_PRETTY_PRINT )."\n";
+        return json_encode( $this->output, JSON_PRETTY_PRINT )."\n";
     }
 
     /**
@@ -132,18 +135,19 @@ public function sanitiseVersion( string $version ): string
      * Collate the IXP specific information for the JSON schema export
      *
      * @param string $version The version to collate the detail for
-     *
-     * @return (|(array|mixed|value-of<TArray>)[]|int|null|string)[][]
-     *
      * @throws
-     *
-     * @psalm-return list{0?: array{shortname: null|string, name: , country: |string, url: , peeringdb_id?: int, ixf_id?: int, ixp_id: int, support_email: , support_phone: , support_contact_hours: , emergency_email: , emergency_phone: , emergency_contact_hours: , billing_contact_hours: , billing_email: , billing_phone: , peering_policy_list: non-empty-list<value-of<never>>, vlan: array<int<0, max>, array<string, mixed>>, switch: array},...}
      */
     private function getIXPInfo( string $version ): array
     {
         $ixpinfo = [];
+        $infrasIncluded = [];
 
         foreach( Infrastructure::with( ['switchers.cabinet.location'] )->get() as $infra ) {
+            
+            if( $infra->exclude_from_ixf_export ) {
+                continue;
+            }
+            
             $i = [];
             $i['shortname'] = $infra->name;
             $i['name'] = config('identity.legalname');
@@ -182,6 +186,8 @@ private function getIXPInfo( string $version ): array
                 }
             }
 
+            $infrasIncluded[] = $infra->id;
+            
             $i['ixp_id'] = $infra->id;    // referenced in member's connections section
 
             $i['support_email'] = config('identity.support_email');
@@ -237,8 +243,10 @@ private function getIXPInfo( string $version ): array
 
             $ixpinfo[] = $i;
         }
-
-        return $ixpinfo;
+        
+        $this->output['ixp_list']    = $ixpinfo;
+        
+        return $infrasIncluded;
     }
 
     /**
@@ -288,16 +296,8 @@ private function getSwitchInfo( string $version, Infrastructure $infra ): array
 
     /**
      * Collate the IXP's member information for the JSON schema export
-     *
-     * @param string $version The version to collate the detail for
-     * @param bool $detailed
-     * @param bool $tags
-     *
-     * @return ((((((stdClass|string)[]|bool|int|mixed|string)[]|int|null)[][]|mixed|string)[]|bool|int|null|string)[]|int|null|string)[][]
-     *
-     * @psalm-return array<int<0, max>, array{asnum: int|null, member_since: string, url: null|string, name: null|string, peering_policy: null|string, member_type: string, contact_email?: list{null|string}, contact_phone?: list{null|string}, peering_policy_url?: null|string, contact_hours?: string, ixp_manager?: array{tags: array<string, string>, in_manrs: bool, is_reseller: bool, is_resold: bool, resold_via_asn?: int|null}, connection_list: list<array{if_list: list{0?: array{if_phys_speed?: int|null, if_speed: int, switch_id: int|null}, ...<array{if_phys_speed?: int|null, if_speed: int, switch_id: int|null}>}, ixp_id: mixed, state: 'active', vlan_list: list{non-empty-array<non-empty-literal-string, array{address: mixed, as_macro?: string, mac_addresses?: list{0?: string, ...<string>}, max_prefix?: int, routeserver: bool, service_type?: list{'ixroutecollector'|'ixrouteserver', ...<'ixroutecollector'|'ixrouteserver'>}, services?: list{stdClass, ...<stdClass>}}|int|null>, ...<non-empty-array<non-empty-literal-string, array{address: mixed, as_macro?: string, mac_addresses?: list{0?: string, ...<string>}, max_prefix?: int, routeserver: bool, service_type?: list{'ixroutecollector'|'ixrouteserver', ...<'ixroutecollector'|'ixrouteserver'>}, services?: list{stdClass, ...<stdClass>}}|int|null>>}}>}>
      */
-    private function getMemberInfo( string $version, bool $detailed, bool $tags ): array
+    private function getMemberInfo( string $version, bool $detailed, bool $tags, array $infrasIncluded ): array
     {
         $memberinfo = [];
 
@@ -374,6 +374,9 @@ private function getMemberInfo( string $version, bool $detailed, bool $tags ): a
                     }
                 }
             }
+            
+            // ensure we have at least one interface on an included infrastructure
+            $atLeastOneInfraIsConnected = false;
 
             foreach( $c->virtualInterfaces as $vi ) {
                 $iflist = [];
@@ -386,6 +389,15 @@ private function getMemberInfo( string $version, bool $detailed, bool $tags ): a
                         continue;
                     }
                     
+                    // is this an infrastructure we are including?
+                    try {
+                        if( !in_array( $pi->switchPort->switcher->infrastructure, $infrasIncluded ) ) {
+                            continue;
+                        }
+                    } catch( \Exception $e ) {
+                        dd($pi);
+                    }
+                    
                     $atLeastOnePiIsPeering = true;
                     
                     if( $pi->statusConnected() ) {
@@ -407,7 +419,9 @@ private function getMemberInfo( string $version, bool $detailed, bool $tags ): a
                 if( !$atLeastOnePiIsPeering || !$atLeastOnePiIsConnected ) {
                     continue;
                 }
-
+                
+                $atLeastOneInfraIsConnected = true;
+                
                 $vlanentries = [];
                 foreach( $vi->vlanInterfaces as $vli ) {
                     if( $vli->vlan->private || !$vli->vlan->export_to_ixf ) {
@@ -507,7 +521,7 @@ private function getMemberInfo( string $version, bool $detailed, bool $tags ): a
 
                 $connlist[] = $conn;
             }
-
+            
             $memberinfo[ $cnt ] = [
                 'asnum'          => $c->autsys,
                 'member_since'   => \Carbon\Carbon::parse($c->datejoin)->format( 'Y-m-d' ).'T00:00:00Z',
@@ -546,10 +560,11 @@ private function getMemberInfo( string $version, bool $detailed, bool $tags ): a
                     $memberinfo[ $cnt ][ 'ixp_manager' ][ 'resold_via_asn' ]   = $c->resellerObject->autsys;
                 }
             }
-
-            $memberinfo[ $cnt ][ 'connection_list' ] = $connlist;
-
-            $cnt++;
+            
+            if( $atLeastOneInfraIsConnected ) {
+                $memberinfo[ $cnt ][ 'connection_list' ] = $connlist;
+                $cnt++;
+            }
         }
 
         return $memberinfo;
diff --git a/database/migrations/2025_11_11_085835_add_exclude_from_ixf_export_to_infrastructure.php b/database/migrations/2025_11_11_085835_add_exclude_from_ixf_export_to_infrastructure.php
@@ -0,0 +1,21 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    public function up(): void
+    {
+        Schema::table( 'infrastructure', function( Blueprint $table ) {
+            $table->boolean( 'exclude_from_ixf_export' )->default( false )->after( 'ixf_ix_id' );
+        } );
+    }
+    
+    public function down(): void
+    {
+        Schema::table( 'infrastructure', function( Blueprint $table ) {
+            $table->dropColumn( 'exclude_from_ixf_export' );
+        } );
+    }
+};
diff --git a/resources/views/infrastructure/edit-form.foil.php b/resources/views/infrastructure/edit-form.foil.php
@@ -59,6 +59,19 @@
                 . "cached for two hours. Use 'artisan cache:clear' to reset it.");
         ?>
 
+        <?= Former::checkbox( 'exclude_from_ixf_export' )
+                ->label( '&nbsp;' )
+                ->text( 'Exclude from IX-F Export' )
+                ->value( 1 )
+                ->inline()
+                ->blockHelp( "By default, all infrastructures (IXPs), their switches, connections, etc., are included in the IX-F export. "
+                        . "Check this box if you do not want to include this infrastructure in the export.<br><br>"
+                        . "If you are unsure, leave this unchecked. For more information, see the "
+                        . "<a href=\"https://docs.ixpmanager.org/latest/features/ixf-export/\" target=\"_blank\">IX-F Export documentation</a>."
+                );
+        ?>
+
+
         <div class="form-group row">
             <div class="col-sm-8">
                 <div class="card">
diff --git a/tests/Browser/InfrastructureControllerTest.php b/tests/Browser/InfrastructureControllerTest.php
@@ -89,6 +89,7 @@ public function testAdd(): void
                 ->type( 'shortname', 'phpunit' )
                 ->select( 'country', 'IE' )
                 ->check( 'isPrimary' )
+                ->check( 'exclude_from_ixf_export' )
                 ->select( 'ixf_ix_id', '1' )
                 ->select( 'peeringdb_ix_id', '1' )
                 ->type( 'notes', 'I am a note' )
@@ -112,10 +113,11 @@ public function testAdd(): void
             $this->assertEquals( 'phpunit', $infra->shortname );
             $this->assertEquals( 'IE', $infra->country );
             $this->assertEquals( 'I am a note', $infra->notes );
-            $this->assertEquals( true, $infra->isPrimary );
             $this->assertEquals( '1', $infra->ixf_ix_id );
             $this->assertEquals( '1', $infra->peeringdb_ix_id );
-
+            $this->assertTrue( $infra->isPrimary );
+            $this->assertTrue( $infra->exclude_from_ixf_export );
+            
             // 3. browse to edit infrastructure object:
             $browser->click( '#e2f-list-edit-' . $infra->id )
                 ->waitForText( 'Edit Infrastructure' );
@@ -126,6 +128,7 @@ public function testAdd(): void
                 ->assertSelected( 'country', 'IE' )
                 ->assertInputValue( 'notes', 'I am a note' )
                 ->assertChecked( 'isPrimary' )
+                ->assertChecked( 'exclude_from_ixf_export' )
                 ->assertSelected( 'ixf_ix_id', '1' )
                 ->assertSelected( 'peeringdb_ix_id', '1' );
 
@@ -135,6 +138,7 @@ public function testAdd(): void
                 ->select( 'peeringdb_ix_id', '2' )
                 ->select( 'country', 'FR' )
                 ->uncheck( 'isPrimary' )
+                ->uncheck( 'exclude_from_ixf_export' )
                 ->press( 'Save Changes' )
                 ->waitForLocation( '/infrastructure/list' )
                 ->assertSee( "Infrastructure updated" );
@@ -148,9 +152,10 @@ public function testAdd(): void
             $this->assertEquals( 'phpunit', $infra->shortname );
             $this->assertEquals( 'I am a note', $infra->notes );
             $this->assertEquals( 'FR', $infra->country );
-            $this->assertEquals( false, $infra->isPrimary );
             $this->assertEquals( '2', $infra->ixf_ix_id );
             $this->assertEquals( '2', $infra->peeringdb_ix_id );
+            $this->assertFalse( $infra->isPrimary );
+            $this->assertFalse( $infra->exclude_from_ixf_export );
 
 
             // 7. edit again and assert that all checkboxes are unchecked and assert select values are as expected
@@ -161,6 +166,7 @@ public function testAdd(): void
                 ->assertInputValue( 'shortname', 'phpunit' )
                 ->assertInputValue( 'notes', 'I am a note' )
                 ->assertNotChecked( 'isPrimary' )
+                ->assertNotChecked( 'exclude_from_ixf_export' )
                 ->assertSelected( 'ixf_ix_id', '2' )
                 ->assertSelected( 'country', 'FR' )
                 ->assertSelected( 'peeringdb_ix_id', '2' );
@@ -178,23 +184,25 @@ public function testAdd(): void
             $this->assertEquals( 'Infrastructure PHPUnit', $infra->name );
             $this->assertEquals( 'phpunit', $infra->shortname );
             $this->assertEquals( 'FR', $infra->country );
-            $this->assertEquals( false, $infra->isPrimary );
             $this->assertEquals( '2', $infra->ixf_ix_id );
             $this->assertEquals( '2', $infra->peeringdb_ix_id );
-
+            $this->assertFalse( $infra->isPrimary );
+            $this->assertFalse( $infra->exclude_from_ixf_export );
 
             // 9. edit again and check all checkboxes and submit
             $browser->visit( '/infrastructure/edit/' . $infra->id )
                 ->waitForText( 'Edit Infrastructure' )
                 ->check( 'isPrimary' )
+                ->check( 'exclude_from_ixf_export' )
                 ->press( 'Save Changes' )
                 ->waitForLocation( '/infrastructure/list' );
 
 
             // 10. verify checkbox bool elements in database are all true
             $infra->refresh();
-
-            $this->assertEquals( true, $infra->isPrimary );
+            
+            $this->assertTrue( $infra->isPrimary );
+            $this->assertTrue( $infra->exclude_from_ixf_export );
 
             // 11. delete the router in the UI and verify via success message text and location
             $browser->visit( '/infrastructure/list/' )
