Namespace game assets (#792)

* update assets with course

* formatting

* update assets model test

* Fix tests

Co-authored-by: angelsl <angelsl@in04.sg>

Author: YaleChen299

config/test.exs

@@ -75,7 +75,7 @@ config :cadet,
     lambda_name: "dummy"
   ],
   uploader: [
-    assets_bucket: "source-academy-assets",
+    assets_bucket: "test-sa-assets",
     sourcecasts_bucket: "test-cadet-sourcecasts"
   ],
   remote_execution: [

lib/cadet/assets/assets.ex

@@ -9,18 +9,18 @@ defmodule Cadet.Assets.Assets do
                         if(Mix.env() == :test, do: ["testFolder"], else: [])
   @accepted_file_types ~w(.jpg .jpeg .gif .png .wav .mp3 .txt)
 
-  def upload_to_s3(upload_params, folder_name, file_name) do
+  def upload_to_s3(upload_params, course_id, folder_name, file_name) do
     file_type = Path.extname(file_name)
 
     with :ok <- validate_file_name(file_name),
          :ok <- validate_folder_name(folder_name),
          :ok <- validate_file_type(file_type) do
-      if object_exists?(folder_name, file_name) do
+      if object_exists?(course_id, folder_name, file_name) do
         {:error, {:bad_request, "File already exists"}}
       else
         file = upload_params.path
 
-        s3_path = "#{folder_name}/#{file_name}"
+        s3_path = "#{course_id}/#{folder_name}/#{file_name}"
 
         file
         |> Upload.stream_file()
@@ -32,11 +32,11 @@ defmodule Cadet.Assets.Assets do
     end
   end
 
-  def list_assets(folder_name) do
+  def list_assets(course_id, folder_name) do
     case validate_folder_name(folder_name) do
       :ok ->
         bucket()
-        |> S3.list_objects(prefix: folder_name <> "/")
+        |> S3.list_objects(prefix: "#{course_id}/" <> folder_name <> "/")
         |> ExAws.stream!()
         |> Enum.map(fn file -> file.key end)
 
@@ -45,12 +45,12 @@ defmodule Cadet.Assets.Assets do
     end
   end
 
-  def delete_object(folder_name, file_name) do
+  def delete_object(course_id, folder_name, file_name) do
     with :ok <- validate_file_name(file_name),
          :ok <- validate_folder_name(folder_name) do
-      if object_exists?(folder_name, file_name) do
+      if object_exists?(course_id, folder_name, file_name) do
         bucket()
-        |> S3.delete_object("#{folder_name}/#{file_name}")
+        |> S3.delete_object("#{course_id}/#{folder_name}/#{file_name}")
         |> ExAws.request!()
 
         :ok
@@ -60,9 +60,10 @@ defmodule Cadet.Assets.Assets do
     end
   end
 
-  @spec object_exists?(binary, binary) :: boolean()
-  def object_exists?(folder_name, file_name) do
-    response = bucket() |> S3.head_object("#{folder_name}/#{file_name}") |> ExAws.request()
+  @spec object_exists?(integer(), binary, binary) :: boolean()
+  def object_exists?(course_id, folder_name, file_name) do
+    response =
+      bucket() |> S3.head_object("#{course_id}/#{folder_name}/#{file_name}") |> ExAws.request()
 
     case response do
       {:error, _error} -> false

lib/cadet_web/admin_controllers/admin_assets_controller.ex

@@ -5,17 +5,20 @@ defmodule CadetWeb.AdminAssetsController do
   alias Cadet.Assets.Assets
 
   def index(conn, _params = %{"foldername" => foldername}) do
-    case Assets.list_assets(foldername) do
+    course_reg = conn.assigns.course_reg
+
+    case Assets.list_assets(course_reg.course_id, foldername) do
       {:error, {status, message}} -> conn |> put_status(status) |> text(message)
       assets -> render(conn, "index.json", assets: assets)
     end
   end
 
   @spec delete(Plug.Conn.t(), map) :: Plug.Conn.t()
   def delete(conn, _params = %{"foldername" => foldername, "filename" => filename}) do
+    course_reg = conn.assigns.course_reg
     filename = Enum.join(filename, "/")
 
-    case Assets.delete_object(foldername, filename) do
+    case Assets.delete_object(course_reg.course_id, foldername, filename) do
       {:error, {status, message}} -> conn |> put_status(status) |> text(message)
       _ -> conn |> put_status(204) |> text('')
     end
@@ -26,9 +29,10 @@ defmodule CadetWeb.AdminAssetsController do
         "filename" => filename,
         "foldername" => foldername
       }) do
+    course_reg = conn.assigns.course_reg
     filename = Enum.join(filename, "/")
 
-    case Assets.upload_to_s3(upload_params, foldername, filename) do
+    case Assets.upload_to_s3(upload_params, course_reg.course_id, foldername, filename) do
       {:error, {status, message}} -> conn |> put_status(status) |> text(message)
       resp -> render(conn, "show.json", resp: resp)
     end

test/cadet/assets/assets_test.exs

@@ -7,31 +7,38 @@ defmodule Cadet.Assets.AssetsTest do
   describe "Manage assets" do
     test "accessible folder" do
       use_cassette "aws/model_list_assets#1" do
-        assert Assets.list_assets("testFolder") === [
-                 "testFolder/",
-                 "testFolder/test.png",
-                 "testFolder/test2.png"
+        assert Assets.list_assets(1, "testFolder") === [
+                 "1/testFolder/",
+                 "1/testFolder/test.png",
+                 "1/testFolder/test2.png"
                ]
       end
     end
 
+    test "access another course with 0 folder" do
+      use_cassette "aws/model_list_assets#2" do
+        assert Assets.list_assets(2, "testFolder") === []
+      end
+    end
+
     test "delete nonexistent file" do
       use_cassette "aws/model_delete_asset#1" do
-        assert Assets.delete_object("testFolder", "test4.png") ===
+        assert Assets.delete_object(1, "testFolder", "test4.png") ===
                  {:error, {:not_found, "File not found"}}
       end
     end
 
     test "delete ok file" do
       use_cassette "aws/model_delete_asset#2" do
-        assert Assets.delete_object("testFolder", "test.png") === :ok
+        assert Assets.delete_object(1, "testFolder", "test.png") === :ok
       end
     end
 
     test "upload existing file" do
       use_cassette "aws/model_upload_asset#1" do
         assert Assets.upload_to_s3(
                  build_upload("test/fixtures/upload.png"),
+                 1,
                  "testFolder",
                  "test2.png"
                ) ===
@@ -43,15 +50,18 @@ defmodule Cadet.Assets.AssetsTest do
       use_cassette "aws/model_upload_asset#2" do
         assert Assets.upload_to_s3(
                  build_upload("test/fixtures/upload.png"),
+                 1,
                  "testFolder",
                  "test1.png"
                ) ===
-                 "https://source-academy-assets.s3.amazonaws.com/testFolder/test1.png"
+                 "https://#{bucket()}.s3.amazonaws.com/1/testFolder/test1.png"
       end
     end
   end
 
   defp build_upload(path, content_type \\ "image\png") do
     %Plug.Upload{path: path, filename: Path.basename(path), content_type: content_type}
   end
+
+  defp bucket, do: :cadet |> Application.fetch_env!(:uploader) |> Keyword.get(:assets_bucket)
 end

test/cadet_web/admin_controllers/admin_assets_controller_test.exs

@@ -94,7 +94,7 @@ defmodule CadetWeb.AdminAssetsControllerTest do
   end
 
   describe "ok request" do
-    @tag authenticate: :staff
+    @tag authenticate: :staff, course_id: 117
     test "index file", %{conn: conn} do
       course_id = conn.assigns.course_id
 
@@ -106,7 +106,7 @@ defmodule CadetWeb.AdminAssetsControllerTest do
       end
     end
 
-    @tag authenticate: :staff
+    @tag authenticate: :staff, course_id: 117
     test "delete file", %{conn: conn} do
       course_id = conn.assigns.course_id
 
@@ -117,7 +117,7 @@ defmodule CadetWeb.AdminAssetsControllerTest do
       end
     end
 
-    @tag authenticate: :staff
+    @tag authenticate: :staff, course_id: 117
     test "upload file", %{conn: conn} do
       course_id = conn.assigns.course_id
 
@@ -128,7 +128,7 @@ defmodule CadetWeb.AdminAssetsControllerTest do
           })
 
         assert json_response(conn, 200) ===
-                 "https://source-academy-assets.s3.amazonaws.com/testFolder/test.png"
+                 "https://#{bucket()}.s3.amazonaws.com/#{course_id}/testFolder/test.png"
       end
     end
   end
@@ -169,7 +169,7 @@ defmodule CadetWeb.AdminAssetsControllerTest do
   end
 
   describe "nested filename request" do
-    @tag authenticate: :staff
+    @tag authenticate: :staff, course_id: 117
     test "delete file", %{conn: conn} do
       course_id = conn.assigns.course_id
 
@@ -180,7 +180,7 @@ defmodule CadetWeb.AdminAssetsControllerTest do
       end
     end
 
-    @tag authenticate: :staff
+    @tag authenticate: :staff, course_id: 117
     test "upload file", %{conn: conn} do
       course_id = conn.assigns.course_id
 
@@ -191,7 +191,7 @@ defmodule CadetWeb.AdminAssetsControllerTest do
           })
 
         assert json_response(conn, 200) ===
-                 "https://source-academy-assets.s3.amazonaws.com/testFolder/nestedFolder/test.png"
+                 "https://#{bucket()}.s3.amazonaws.com/#{course_id}/testFolder/nestedFolder/test.png"
       end
     end
   end
@@ -202,4 +202,6 @@ defmodule CadetWeb.AdminAssetsControllerTest do
   defp build_upload(path, content_type \\ "image/png") do
     %Plug.Upload{path: path, filename: Path.basename(path), content_type: content_type}
   end
+
+  defp bucket, do: :cadet |> Application.fetch_env!(:uploader) |> Keyword.get(:assets_bucket)
 end

test/fixtures/vcr_cassettes/aws/controller_delete_asset#1.json

@@ -15,7 +15,7 @@
         "recv_timeout": 660000
       },
       "request_body": "",
-      "url": "https://s3.ap-southeast-1.amazonaws.com/source-academy-assets/testFolder/test2.png"
+      "url": "https://s3.ap-southeast-1.amazonaws.com/test-sa-assets/117/testFolder/test2.png"
     },
     "response": {
       "binary": false,
@@ -49,7 +49,7 @@
         "recv_timeout": 660000
       },
       "request_body": "",
-      "url": "https://s3.ap-southeast-1.amazonaws.com/source-academy-assets/testFolder/test2.png"
+      "url": "https://s3.ap-southeast-1.amazonaws.com/test-sa-assets/117/testFolder/test2.png"
     },
     "response": {
       "binary": false,
@@ -62,4 +62,4 @@
       "type": "ok"
     }
   }
-]
+]

test/fixtures/vcr_cassettes/aws/controller_delete_asset#2.json

@@ -5,7 +5,7 @@
       "headers": {
         "Authorization": "***",
         "host": "s3.ap-southeast-1.amazonaws.com",
-        "x-amz-date": "20200704T190420Z",
+        "x-amz-date": "20200704T190423Z",
         "content-length": "0",
         "x-amz-content-sha256": "***"
       },
@@ -15,14 +15,14 @@
         "recv_timeout": 660000
       },
       "request_body": "",
-      "url": "https://s3.ap-southeast-1.amazonaws.com/source-academy-assets/testFolder/nestedFolder/test2.png"
+      "url": "https://s3.ap-southeast-1.amazonaws.com/test-sa-assets/117/testFolder/nestedFolder/test2.png"
     },
     "response": {
       "binary": false,
       "body": null,
       "headers": {
-        "Date": "Sat, 04 Jul 2020 19:04:21 GMT",
-        "Last-Modified": "Sat, 04 Jul 2020 19:03:31 GMT",
+        "Date": "Sat, 04 Jul 2020 19:04:24 GMT",
+        "Last-Modified": "Sat, 04 Jul 2020 18:58:52 GMT",
         "ETag": "\"3104001edec38fadeb925b9dbddab198\"",
         "Accept-Ranges": "bytes",
         "Content-Type": "image/png",
@@ -39,7 +39,7 @@
       "headers": {
         "Authorization": "***",
         "host": "s3.ap-southeast-1.amazonaws.com",
-        "x-amz-date": "20200704T190421Z",
+        "x-amz-date": "20200704T190423Z",
         "content-length": "0",
         "x-amz-content-sha256": "***"
       },
@@ -49,17 +49,17 @@
         "recv_timeout": 660000
       },
       "request_body": "",
-      "url": "https://s3.ap-southeast-1.amazonaws.com/source-academy-assets/testFolder/nestedFolder/test2.png"
+      "url": "https://s3.ap-southeast-1.amazonaws.com/test-sa-assets/117/testFolder/nestedFolder/test2.png"
     },
     "response": {
       "binary": false,
       "body": "",
       "headers": {
-        "Date": "Sat, 04 Jul 2020 19:04:22 GMT",
+        "Date": "Sat, 04 Jul 2020 19:04:24 GMT",
         "Server": "AmazonS3"
       },
       "status_code": 204,
       "type": "ok"
     }
   }
-]
+]

test/fixtures/vcr_cassettes/aws/controller_list_assets#1.json

@@ -14,11 +14,11 @@
         "recv_timeout": 660000
       },
       "request_body": "",
-      "url": "https://s3.ap-southeast-1.amazonaws.com/source-academy-assets/"
+      "url": "https://s3.ap-southeast-1.amazonaws.com/test-sa-assets/"
     },
     "response": {
       "binary": false,
-      "body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ListBucketResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\"><Name>source-academy-assets</Name><Prefix>testFolder/</Prefix><Marker></Marker><MaxKeys>1000</MaxKeys><IsTruncated>false</IsTruncated><Contents><Key>testFolder/</Key><LastModified>2020-07-04T18:53:11.000Z</LastModified><ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag><Size>0</Size><Owner><ID>98bd2bd2de0c976fb511f741fea454cb1026b9e1f9ac9160fd9f51d07e765f19</ID><DisplayName>unixsp+cs1101s</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>testFolder/test.png</Key><LastModified>2020-07-04T19:04:50.000Z</LastModified><ETag>&quot;3104001edec38fadeb925b9dbddab198&quot;</ETag><Size>8035</Size><Owner><ID>98bd2bd2de0c976fb511f741fea454cb1026b9e1f9ac9160fd9f51d07e765f19</ID><DisplayName>unixsp+cs1101s</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>testFolder/test2.png</Key><LastModified>2020-07-04T19:04:50.000Z</LastModified><ETag>&quot;3104001edec38fadeb925b9dbddab198&quot;</ETag><Size>8035</Size><Owner><ID>98bd2bd2de0c976fb511f741fea454cb1026b9e1f9ac9160fd9f51d07e765f19</ID><DisplayName>unixsp+cs1101s</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents></ListBucketResult>",
+      "body": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ListBucketResult xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\"><Name>test-sa-assets</Name><Prefix>117/testFolder/</Prefix><Marker></Marker><MaxKeys>1000</MaxKeys><IsTruncated>false</IsTruncated><Contents><Key>testFolder/</Key><LastModified>2020-07-04T18:53:11.000Z</LastModified><ETag>&quot;d41d8cd98f00b204e9800998ecf8427e&quot;</ETag><Size>0</Size><Owner><ID>98bd2bd2de0c976fb511f741fea454cb1026b9e1f9ac9160fd9f51d07e765f19</ID><DisplayName>unixsp+cs1101s</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>testFolder/test.png</Key><LastModified>2020-07-04T19:04:50.000Z</LastModified><ETag>&quot;3104001edec38fadeb925b9dbddab198&quot;</ETag><Size>8035</Size><Owner><ID>98bd2bd2de0c976fb511f741fea454cb1026b9e1f9ac9160fd9f51d07e765f19</ID><DisplayName>unixsp+cs1101s</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents><Contents><Key>testFolder/test2.png</Key><LastModified>2020-07-04T19:04:50.000Z</LastModified><ETag>&quot;3104001edec38fadeb925b9dbddab198&quot;</ETag><Size>8035</Size><Owner><ID>98bd2bd2de0c976fb511f741fea454cb1026b9e1f9ac9160fd9f51d07e765f19</ID><DisplayName>unixsp+cs1101s</DisplayName></Owner><StorageClass>STANDARD</StorageClass></Contents></ListBucketResult>",
       "headers": {
         "Date": "Sat, 04 Jul 2020 19:04:57 GMT",
         "x-amz-bucket-region": "ap-southeast-1",