update tests for sb3 import functionality

Author: rammodhvadia

spec/jobs/upload_job_spec.rb

@@ -269,6 +269,116 @@
     end
   end
 
+  context 'when a scratch project is uploaded' do
+    let(:scratch_payload) do
+      {
+        repository: { name: 'my-amazing-repo', owner: { name: 'me' } },
+        commits: [{ added: ['ja-JP/code/scratch-integration-test-starter/main.sb3'], modified: [], removed: [] }]
+      }
+    end
+    let(:scratch_project_json) do
+      {
+        targets: [
+          {
+            costumes: [{ md5ext: 'test_image_1.png' }],
+            sounds: [{ md5ext: 'test_audio_1.mp3' }]
+          }
+        ]
+      }
+    end
+    let(:scratch_sb3_body) do
+      sb3_archive_string(
+        'project.json' => scratch_project_json.to_json,
+        'test_image_1.png' => sb3_fixture_content('test_image_1.png'),
+        'test_audio_1.mp3' => sb3_fixture_content('test_audio_1.mp3')
+      )
+    end
+    let(:raw_response) do
+      {
+        data: {
+          repository: {
+            object: {
+              __typename: 'Tree',
+              entries: [
+                {
+                  name: 'scratch-integration-test-starter',
+                  object: {
+                    __typename: 'Tree',
+                    entries: [
+                      {
+                        name: 'main.sb3',
+                        extension: '.sb3',
+                        object: {
+                          __typename: 'Blob',
+                          text: nil,
+                          isBinary: true
+                        }
+                      },
+                      {
+                        name: 'project_config.yml',
+                        extension: '.yml',
+                        object: {
+                          __typename: 'Blob',
+                          text: "name: \"Scratch Integration Test\"\nidentifier: \"scratch-integration-test-starter\"\ntype: \"code_editor_scratch\"\n",
+                          isBinary: false
+                        }
+                      }
+                    ]
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }.deep_stringify_keys
+    end
+
+    before do
+      allow(GithubApi::Client).to receive(:query).and_return(graphql_response)
+      allow(ProjectImporter).to receive(:new).and_call_original
+
+      stub_request(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/scratch-integration-test-starter/main.sb3')
+        .to_return(status: 200, body: scratch_sb3_body, headers: {})
+    end
+
+    it 'imports the Scratch project with the sb3 component as io' do
+      described_class.perform_now(scratch_payload)
+
+      expect(ProjectImporter).to have_received(:new).with(
+        hash_including(
+          name: 'Scratch Integration Test',
+          identifier: 'scratch-integration-test-starter',
+          type: Project::Types::CODE_EDITOR_SCRATCH,
+          locale: 'ja-JP',
+          images: [],
+          videos: [],
+          audio: [],
+          components: [
+            hash_including(
+              name: 'main',
+              extension: 'sb3',
+              io: an_object_responding_to(:read)
+            )
+          ]
+        )
+      )
+    end
+
+    it 'requests the sb3 file from the correct URL' do
+      described_class.perform_now(scratch_payload)
+
+      expect(WebMock).to have_requested(:get, 'https://github.com/me/my-amazing-repo/raw/branches/whatever/ja-JP/code/scratch-integration-test-starter/main.sb3').once
+    end
+
+    it 'saves the Scratch project to the database' do
+      expect { described_class.perform_now(scratch_payload) }.to change(Project, :count).by(1)
+
+      project = Project.find_by(identifier: 'scratch-integration-test-starter', locale: 'ja-JP')
+      expect(project.project_type).to eq(Project::Types::CODE_EDITOR_SCRATCH)
+      expect(project.scratch_component.content).to eq(JSON.parse(scratch_project_json.to_json))
+    end
+  end
+
   context 'when locale is unsupported' do
     let(:raw_response) { { data: { repository: nil } } }
     let(:bad_payload) do

spec/lib/project_importer_spec.rb

@@ -114,4 +114,105 @@
       expect { importer.import! }.to change { project.reload.audio[0].filename.to_s }.to('my-amazing-audio.mp3')
     end
   end
+
+  context 'when the project has type code_editor_scratch' do
+    let(:scratch_project_file) { Tempfile.new(['test_scratch_project', '.sb3']) }
+    let(:importer) do
+      described_class.new(
+        name: 'My amazing Scratch project',
+        identifier: 'my-amazing-scratch-project',
+        type: Project::Types::CODE_EDITOR_SCRATCH,
+        locale: 'en',
+        components: [
+          { name: 'main', extension: 'sb3', file_path: scratch_project_file.path }
+        ]
+      )
+    end
+    let(:scratch_project_content) do
+      {
+        targets: [
+          {
+            costumes: [{ md5ext: 'test_image_1.png' }],
+            sounds: [{ md5ext: 'test_audio_1.mp3' }],
+            videos: [{ md5ext: 'test_video_1.mp4' }]
+          }
+        ]
+      }
+    end
+
+    let(:project) { Project.find_by(identifier: importer.identifier, user_id: nil, locale: importer.locale) }
+
+    before do
+      scratch_project_file.binmode
+      scratch_project_file.write(
+        sb3_archive(
+          'project.json' => scratch_project_content.to_json,
+          'test_image_1.png' => sb3_fixture_content('test_image_1.png'),
+          'test_video_1.mp4' => sb3_fixture_content('test_video_1.mp4'),
+          'test_audio_1.mp3' => sb3_fixture_content('test_audio_1.mp3')
+        ).read
+      )
+      scratch_project_file.flush
+    end
+
+    after do
+      scratch_project_file.close
+      scratch_project_file.unlink
+    end
+
+    context 'when importing a new scratch project' do
+      it 'imports the Scratch component content' do
+        importer.import!
+
+        expect(project.components.count).to eq(0)
+        expect(project.scratch_component.content).to eq(JSON.parse(scratch_project_content.to_json))
+      end
+
+      it 'imports the project assets' do
+        importer.import!
+        expect(ScratchAsset.global_assets.where(filename: ['test_image_1.png', 'test_video_1.mp4', 'test_audio_1.mp3']).count).to eq(3)
+      end
+    end
+
+    context 'when the scratch project already exists in the database' do
+      let(:original_scratch_content) do
+        { targets: ['old target'], monitors: [], extensions: [], meta: {} }
+      end
+      let!(:project) do
+        create(
+          :project,
+          identifier: 'my-amazing-scratch-project',
+          locale: 'en',
+          project_type: Project::Types::CODE_EDITOR_SCRATCH,
+          name: 'Old Scratch project name'
+        )
+      end
+
+      before do
+        create(:scratch_component, project:, content: original_scratch_content)
+      end
+
+      it 'does not create a new project' do
+        expect { importer.import! }.not_to change(Project, :count)
+      end
+
+      it 'updates the project name' do
+        expect { importer.import! }.to change { project.reload.name }.to(importer.name)
+      end
+
+      it 'updates the scratch component content' do
+        importer.import!
+
+        expect(project.reload.scratch_component.content).to eq(JSON.parse(scratch_project_content.to_json))
+      end
+
+      it 'imports any new assets without duplicating existing ones' do
+        create(:scratch_asset, :with_file, filename: 'test_image_1.png')
+
+        importer.import!
+
+        expect(ScratchAsset.global_assets.where(filename: ['test_image_1.png', 'test_video_1.mp4', 'test_audio_1.mp3']).count).to eq(3)
+      end
+    end
+  end
 end

spec/lib/scratch_asset_importer_spec.rb

@@ -118,4 +118,63 @@
       end
     end
   end
+
+  describe '.import_all_from_sb3' do
+    def sb3_asset(filename, content = sb3_fixture_content(filename))
+      { filename:, io: StringIO.new(content) }
+    end
+
+    it 'imports assets from SB3 archive content' do
+      png_content = sb3_fixture_content('test_image_1.png')
+
+      described_class.import_all_from_sb3([sb3_asset('test_image_1.png', png_content)])
+
+      scratch_asset = ScratchAsset.find_by(filename: 'test_image_1.png')
+      expect(scratch_asset).to be_present
+      expect(scratch_asset).to be_global
+      expect(scratch_asset.file.download).to eq(png_content)
+    end
+
+    it 'does nothing if global asset already exists' do
+      create(:scratch_asset, :with_file, filename: 'test_image_1.png')
+
+      expect do
+        described_class.import_all_from_sb3([sb3_asset('test_image_1.png')])
+      end.not_to change(ScratchAsset, :count)
+    end
+
+    it 'can import multiple assets' do
+      described_class.import_all_from_sb3([
+                                            sb3_asset('test_image_1.png'),
+                                            sb3_asset('test_audio_1.mp3', sb3_fixture_content('test_audio_1.mp3'))
+                                          ])
+
+      expect(ScratchAsset.find_by(filename: 'test_image_1.png')).to be_present
+      expect(ScratchAsset.find_by(filename: 'test_audio_1.mp3')).to be_present
+    end
+
+    it 'still imports a global asset when a project asset already uses the filename' do
+      project = create(:project, project_type: Project::Types::CODE_EDITOR_SCRATCH, locale: nil, user_id: SecureRandom.uuid)
+      create(:scratch_component, project:)
+      create(:scratch_asset, :with_file, filename: 'test_image_1.png', project:)
+
+      expect do
+        described_class.import_all_from_sb3([sb3_asset('test_image_1.png')])
+      end.to change { ScratchAsset.global_assets.where(filename: 'test_image_1.png').count }.by(1)
+    end
+
+    it 'skips assets that fail to import' do
+      allow(ScratchAsset).to receive(:create!).and_call_original
+      allow(ScratchAsset).to receive(:create!).with(filename: 'failing.png', project_id: nil, uploaded_user_id: nil)
+                                              .and_raise(StandardError, 'attach failed')
+
+      described_class.import_all_from_sb3([
+                                            sb3_asset('failing.png', 'bad'),
+                                            sb3_asset('test_image_1.png')
+                                          ])
+
+      expect(ScratchAsset.find_by(filename: 'failing.png')).not_to be_present
+      expect(ScratchAsset.find_by(filename: 'test_image_1.png')).to be_present
+    end
+  end
 end