Add support for S3-compatible storage in Result Uploader

Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 ruby '>= 3.1.0'
 
 gem 'activesupport'
+gem 'aws-sdk-s3'
 gem 'csv'
 gem 'curb'
 gem 'dotenv'

Gemfile.lock

@@ -26,6 +26,22 @@ GEM
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
+    aws-eventstream (1.3.0)
+    aws-partitions (1.986.0)
+    aws-sdk-core (3.209.1)
+      aws-eventstream (~> 1, >= 1.3.0)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.9)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-kms (1.94.0)
+      aws-sdk-core (~> 3, >= 3.207.0)
+      aws-sigv4 (~> 1.5)
+    aws-sdk-s3 (1.167.0)
+      aws-sdk-core (~> 3, >= 3.207.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.5)
+    aws-sigv4 (1.10.0)
+      aws-eventstream (~> 1, >= 1.0.2)
     base64 (0.2.0)
     bigdecimal (3.1.8)
     builder (3.3.0)
@@ -57,6 +73,7 @@ GEM
     httpclient (2.8.3)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
+    jmespath (1.6.2)
     json (2.7.2)
     jwt (2.8.1)
       base64
@@ -191,6 +208,7 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport
+  aws-sdk-s3
   code-scanning-rubocop
   csv
   curb

lib/resultuploaders/s3/s3.json

@@ -0,0 +1,5 @@
+{
+    "bucket_name": "auto-hck-result",
+    "region":  "us-east-1",
+    "endpoint": "s3.amazonaws.com"
+}

lib/resultuploaders/s3/s3.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module AutoHCK
+  # S3 class for managing interactions with S3-compatible storage services.
+  # This class is designed to work with services that are compatible with the S3 API,
+  # including AWS S3 and Alibaba Cloud OSS.
+  class S3
+    CONFIG_JSON = 'lib/resultuploaders/s3/s3.json'
+    INDEX_FILE_NAME = 'index.html'
+
+    include Helper
+
+    # Provides read access to the URL for the index.html file.
+    #
+    # In the context of S3 compatibility, there is no concept of folders.
+    # The `url` will point to an index.html file that records the paths of all files.
+    # This allows `index.html` to be displayed directly in HTML format.
+    #
+    # Note: While AWS S3 supports this behavior of rendering HTML files directly,
+    # not all S3-compatible storage services do. For example, Alibaba Cloud OSS
+    # has security restrictions on its default domain that may require files to be
+    # downloaded rather than rendered directly, thus preventing HTML files from being displayed.
+    attr_reader :url
+
+    def initialize(project)
+      tag = project.engine_tag
+      timestamp = project.timestamp
+      repo = project.config['repository']
+      @path = "#{repo}/CI/#{tag}-#{timestamp}"
+
+      @logger = project.logger
+
+      @bucket = new_bucket
+
+      @index_obj = @bucket.object("#{@path}/#{INDEX_FILE_NAME}")
+      @index_template = ERB.new(File.read('lib/templates/index.html.erb'))
+      @filenames = []
+    end
+
+    def html_url; end
+
+    # The current exception handling only logs errors without any additional recovery or fallback mechanisms.
+    # Rescue only Aws::Errors::ServiceError and Seahorse::Client::NetworkingError,
+    # as rescuing StandardError may suppress other programming errors (e.g., NoMethodError).
+    # This approach focuses on handling networking errors and those reported by the storage service.
+    # Future enhancements may include more robust error handling strategies and raising a special error class
+    # instead of just logging when we need to handle errors in callers.
+    def handle_exceptions(where)
+      yield
+    rescue Aws::Errors::ServiceError, Seahorse::Client::NetworkingError => e
+      @logger.warn("S3 #{where} error: #{e.detailed_message}")
+      false
+    end
+
+    # These methods are intentionally left blank to maintain the interface,
+    # as S3-compatible does not require this function. It prevents external calls
+    # from causing errors while adhering to the expected API structure.
+    def ask_token; end
+
+    def connect
+      true
+    end
+
+    def create_project_folder
+      handle_exceptions(__method__) do
+        generate_index
+        @url = @index_obj.public_url
+        @logger.info("S3 project folder created: #{@url}")
+        true
+      end
+    end
+
+    def upload_file(l_path, r_name)
+      handle_exceptions(__method__) do
+        r_path = "#{@path}/#{r_name}"
+        type = 'text/html' if r_name.end_with?('.html')
+        obj = @bucket.object(r_path)
+        obj.upload_file(l_path, content_type: type)
+        @filenames << r_name
+        generate_index
+        @logger.info("S3 file uploaded: #{r_path}")
+        true
+      end
+    end
+
+    def update_file_content(content, r_name)
+      handle_exceptions(__method__) do
+        r_path = "#{@path}/#{r_name}"
+        obj = @bucket.object(r_path)
+        obj.put(body: content)
+        @logger.info("S3 file content updated: #{r_path}")
+        true
+      end
+    end
+
+    def delete_file(r_name)
+      handle_exceptions(__method__) do
+        r_path = "#{@path}/#{r_name}"
+        obj = @bucket.object(r_path)
+        obj.delete
+        @filenames.delete(r_name)
+        generate_index
+        @logger.info("S3 file deleted: #{r_path}")
+        true
+      end
+    end
+
+    def close; end
+
+    private
+
+    def new_bucket
+      access_key_id = ENV.fetch('AUTOHCK_S3_ACCESS_KEY_ID')
+      secret_access_key = ENV.fetch('AUTOHCK_S3_SECRET_ACCESS_KEY')
+
+      config = Json.read_json(CONFIG_JSON, @logger)
+      region = config['region']
+      bucket_name = config['bucket_name']
+      endpoint = config['endpoint']
+
+      s3_resource = Aws::S3::Resource.new(
+        access_key_id:,
+        secret_access_key:,
+        region:,
+        endpoint: "https://#{endpoint}"
+      )
+
+      s3_resource.bucket(bucket_name)
+    end
+
+    def generate_index
+      handle_exceptions(__method__) do
+        index_data = {
+          'path' => @path,
+          'filenames' => @filenames,
+          'bucket' => @bucket
+        }
+        @index_obj.put(body: @index_template.result_with_hash(index_data), content_type: 'text/html')
+        true
+      end
+    end
+  end
+end

lib/templates/index.html.erb

@@ -0,0 +1,23 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title><%= path %></title>
+    <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet">
+</head>
+<body>
+    <div class="container">
+        <h1 class="text-center mt-5"><%= path %></h1>
+        <ul class="list-group mt-3">
+            <% filenames.each do |filename| %>
+                <% url = bucket.object("#{path}/#{filename}").public_url %>
+                <li class="list-group-item">
+                    <a href="<%= url %>"><%= filename %></a>
+                </li>
+            <% end %>
+        </ul>
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js"></script>
+</body>
+</html>