RSpec测试MiniMagick文件转换功能本地通过但GitLab CI/CD报错

问题背景 #

基于MiniMagick实现了ConverterFile文件格式转换类，本地RSpec测试运行正常，但GitLab CI/CD流水线执行测试时报错。

核心实现代码 #

class ConverterFile
  attr_accessor :old_file

  SUPPORT_IMAGE_FORMAT = %w[png jpg jpeg pdf].freeze

  def initialize(old_file)
    @old_file = old_file
  end

  def to_image_type(file_format)
    raise 'format not support' if file_format.blank? || SUPPORT_IMAGE_FORMAT.exclude?(file_format)

    return old_file if File.extname(@old_file) == ".#{file_format}"

    converted_file = MiniMagick::Image.open(@old_file.path)
    converted_file.format(file_format)
    File.open(converted_file.path)
  rescue StandardError => e
    nil
  end
end

RSpec测试用例 #

describe '#to_image_type' do
  let(:png_file)    { File.open(Rails.root.join('spec/support/files/logo.png')) }
  
  context 'when convert to jpg file' do
    it 'convert png file to jpg successfuly' do
      new_file = described_class.new(png_file).to_image_type('jpg')
      expect(File.extname(new_file)).to eq('.jpg')
    end
  end
end

排查方案 #

• 验证测试文件是否被提交到代码仓库
  检查.gitignore文件是否过滤了spec/support/files/目录下的png文件，或者logo.png是否未被提交到远程仓库，导致CI环境拉取代码后缺少测试用的源文件。
• 检查CI运行环境是否安装ImageMagick依赖
  MiniMagick是基于ImageMagick的封装，CI环境的基础镜像如果没有预装ImageMagick，会导致格式转换逻辑直接报错被rescue捕获返回nil，最终测试断言失败。可在CI脚本执行测试前新增convert -version命令验证是否安装成功。
• 检查CI环境文件读写权限
  验证CI执行用户是否有spec/support/files/目录的读权限，以及MiniMagick生成临时文件的目录（默认是系统/tmp目录）的读写权限，权限不足会导致文件读取、转换写入失败。
• 新增错误日志定位根因
  暂时注释to_image_type方法中的rescue逻辑，或者在rescue块中新增日志打印异常详情，在CI运行日志中查看具体报错信息，精准定位问题。

常见解决方案 #

1. 缺失测试文件：将logo.png提交到代码仓库，调整.gitignore规则排除对该测试文件的过滤
2. 缺少ImageMagick依赖：在CI的安装步骤中新增对应系统的ImageMagick安装命令，比如Debian/Ubuntu系镜像添加apt-get update && apt-get install -y imagemagick，Alpine镜像添加apk add imagemagick
3. 权限问题：在CI脚本中新增权限修改命令，比如chmod -R 755 spec/support/files/ /tmp调整对应目录权限
4. 避免空值报错：如果转换失败返回nil会直接调用File.extname报错，可调整测试断言先验证转换成功，再校验文件后缀。

内容的提问来源于stack exchange，提问作者Alluresz