Add Note type to GraphQL schema (#2451)

This PR continues our ongoing effort to build out the new GraphQL API by
adding a Note type to the API.

app/cdash/tests/CMakeLists.txt

@@ -213,8 +213,11 @@ set_tests_properties(/Feature/GraphQL/TestTypeTest PROPERTIES DEPENDS /Feature/G
 add_laravel_test(/Feature/GraphQL/TestMeasurementTypeTest)
 set_tests_properties(/Feature/GraphQL/TestMeasurementTypeTest PROPERTIES DEPENDS /Feature/GraphQL/BuildTypeTest)
 
+add_laravel_test(/Feature/GraphQL/NoteTypeTest)
+set_tests_properties(/Feature/GraphQL/NoteTypeTest PROPERTIES DEPENDS /Feature/GraphQL/BuildTypeTest)
+
 add_laravel_test(/Feature/PurgeUnusedProjectsCommand)
-set_tests_properties(/Feature/PurgeUnusedProjectsCommand PROPERTIES DEPENDS "/Feature/GraphQL/TestTypeTest;/Feature/GraphQL/TestMeasurementTypeTest")
+set_tests_properties(/Feature/PurgeUnusedProjectsCommand PROPERTIES DEPENDS "/Feature/GraphQL/TestTypeTest;/Feature/GraphQL/TestMeasurementTypeTest;/Feature/GraphQL/NoteTypeTest")
 
 add_laravel_test(/Feature/TestSchemaMigration)
 set_tests_properties(/Feature/TestSchemaMigration PROPERTIES DEPENDS /Feature/PurgeUnusedProjectsCommand)

graphql/schema.graphql

@@ -222,6 +222,8 @@ type Build {
  basicWarnings: [BasicBuildAlert!]! @hasMany(type: CONNECTION) @orderBy(column: "id", direction: DESC)
 
  project: Project! @belongsTo
+
+ notes: [Note!]! @belongsToMany(type: CONNECTION) @orderBy(column: "id", direction: DESC)
 }
 
 input BuildFilterInput {
@@ -380,3 +382,22 @@ type SiteInformation {
 
  description: String
 }
+
+
+"""
+Note.
+"""
+type Note {
+ "Unique primary key."
+ id: ID!
+
+ name: String!
+
+ text: String!
+}
+
+input NoteFilterInput {
+ id: ID
+ name: String
+ text: String
+}

tests/Feature/GraphQL/NoteTypeTest.php

@@ -0,0 +1,155 @@
+<?php
+
+namespace Tests\Feature\GraphQL;
+
+use App\Models\Note;
+use App\Models\Project;
+use Illuminate\Support\Str;
+use Tests\TestCase;
+use Tests\Traits\CreatesProjects;
+use Tests\Traits\CreatesUsers;
+
+class NoteTypeTest extends TestCase
+{
+ use CreatesUsers;
+ use CreatesProjects;
+
+ private Project $public_project;
+ private Project $private_project;
+
+ /**
+ * Only submitted to the public project
+ */
+ private Note $note1;
+
+ /**
+ * Only submitted to the private project
+ */
+ private Note $note2;
+
+ /**
+ * Submitted to both the public and private projects
+ */
+ private Note $note3;
+
+ /**
+ * @throws \Random\RandomException
+ */
+ protected function setUp(): void
+ {
+ parent::setUp();
+
+ $this->public_project = $this->makePublicProject();
+ $this->private_project = $this->makePrivateProject();
+
+ $this->note1 = Note::create([
+ 'name' => Str::uuid()->toString(),
+ 'text' => Str::uuid()->toString(),
+ 'crc32' => random_int(0, 100000),
+ ]);
+
+ $this->note2 = Note::create([
+ 'name' => Str::uuid()->toString(),
+ 'text' => Str::uuid()->toString(),
+ 'crc32' => random_int(0, 100000),
+ ]);
+
+ $this->note3 = Note::create([
+ 'name' => Str::uuid()->toString(),
+ 'text' => Str::uuid()->toString(),
+ 'crc32' => random_int(0, 100000),
+ ]);
+
+ $this->public_project->builds()->create([
+ 'name' => 'build1',
+ 'uuid' => Str::uuid()->toString(),
+ ])->notes()->attach([
+ $this->note1->id,
+ $this->note3->id,
+ ]);
+
+ $this->private_project->builds()->create([
+ 'name' => 'build2',
+ 'uuid' => Str::uuid()->toString(),
+ ])->notes()->attach([
+ $this->note2->id,
+ $this->note3->id,
+ ]);
+
+ }
+
+ protected function tearDown(): void
+ {
+ $this->public_project->delete();
+ $this->private_project->delete();
+
+ $this->note1->delete();
+ $this->note2->delete();
+ $this->note3->delete();
+
+ parent::tearDown();
+ }
+
+ /**
+ * A basic test to ensure that each of the fields works
+ */
+ public function testBasicFieldAccess(): void
+ {
+ $this->graphQL('
+ query project($id: ID) {
+ project(id: $id) {
+ builds {
+ edges {
+ node {
+ name
+ notes {
+ edges {
+ node {
+ id
+ name
+ text
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ ', [
+ 'id' => $this->public_project->id,
+ ])->assertJson([
+ 'data' => [
+ 'project' => [
+ 'builds' => [
+ 'edges' => [
+ [
+ 'node' => [
+ 'name' => 'build1',
+ 'notes' => [
+ 'edges' => [
+ [
+ 'node' => [
+ 'id' => (string) $this->note3->id,
+ 'name' => $this->note3->name,
+ 'text' => $this->note3->text,
+ ],
+ ],
+ [
+ 'node' => [
+ 'id' => (string) $this->note1->id,
+ 'name' => $this->note1->name,
+ 'text' => $this->note1->text,
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ], true);
+ }
+}