shopify-cli 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 200674ac9337744994af930500ea30904f13292fba380ec0d58cf990f94c50f5
-  data.tar.gz: cb7f7b17ebbdbc430afe269d713e68cf9db00e71a7aa5026c1752ba8f2db9792
+  metadata.gz: d5e31b928a8c3d1e98c383786f85be502045be59731cef6adcd2fde4f337c4d7
+  data.tar.gz: c0f5fc0e586f2fef7a7e2a92d9357acf06547b53545bc1319e6bcf58f636fb1b
 SHA512:
-  metadata.gz: eed6884b0ee2ec5dc30bfbd4927dedb13ac3a77088af02a24ada09b08d1341696c56c8ce01d177cffe7c67f5db262d2146c51a0f95345e628c1e8a477debe543
-  data.tar.gz: e5211bf92e8b8cab56a17e3714ffcc3d8a8bf8d63aa408c4621a1a65778d4ff0a0d3ae6c57613ee46661d19d9441246aa57388f58f46116acbb712c8f1841750
+  metadata.gz: 9699459d8bf5a49683a00b8b166a7dc5b09be204b5d0bc0d73288508dc08eace03ddba62223f20001183931895434102f8d5cfd66f3494afc1f2fa5d1a4700c5
+  data.tar.gz: e980565315b842028e05786f1acf63fae983d00ff28aa2db71d976d3b3b3615a530c47710727fe83c311a6bca8cec0995fc34cb5a288a7ff2d223510ddd0c79f

data/.github/CODEOWNERS

@@ -1,4 +1,5 @@
 *       @shopify/core-build-learn
+*       @shopify/development-lifecycle
 
 /lib/project_types/script/ @shopify/scripts-experience
 /test/project_types/script/ @shopify/scripts-experience

data/.github/workflows/shopify.yml

@@ -0,0 +1,106 @@
+name: Shopify
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+concurrency:
+  group: shopify-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Tests with Ruby ${{ matrix.version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        version:
+          - 3.0.2
+          - 2.6.6
+          - 2.7.1
+        os:
+          - macos-10.15
+          - macos-11
+          - ubuntu-20.04
+          - ubuntu-18.04
+          - ubuntu-16.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set Git configuration
+        run: |
+          git config --global user.email "development-lifecycle@shopify.com"
+          git config --global user.name "Development Lifecycle"
+
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+          bundler-cache: true
+
+      - name: Install Dependencies
+        run: bundle install
+
+      - name: Run Tests
+        run: bundle exec rake test
+  acceptance_tests:
+    name: Acceptance Tests with Ruby ${{ matrix.version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        version:
+          - 3.0.2
+          - 2.6.6
+          - 2.7.1
+        os:
+          - macos-10.15
+          - macos-11
+          - ubuntu-20.04
+          - ubuntu-18.04
+          - ubuntu-16.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set Git configuration
+        run: |
+          git config --global user.email "development-lifecycle@shopify.com"
+          git config --global user.name "Development Lifecycle"
+
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+          bundler-cache: true
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "14.9.0"
+
+      - name: Install Dependencies
+        run: bundle install
+
+      - name: Run Tests
+        run: bundle exec cucumber
+  rubocop:
+    name: Rubocop
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        version:
+          - 3.0.2
+        os:
+          - macos-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+          bundler-cache: true
+
+      - name: Install Dependencies
+        run: bundle install
+
+      - name: Rubocop
+        run: bundle exec rake rubocop

data/.gitignore

@@ -19,3 +19,5 @@ packaging/debian/shopify-cli
 packaging/debian/shopify-cli.deb
 packaging/rpm/build
 packaging/rpm/shopify-cli.spec
+.byebug_history
+ext/shopify-extensions/shopify-extensions

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 Unreleased
 ------
 
+Version 2.4.0
+------
+
+* [#1488](https://github.com/Shopify/shopify-cli/pull/1488): Update Theme-Check to 1.4
+* [#1507](https://github.com/Shopify/shopify-cli/pull/1507): Limit the generated name for themes to 50 characters
+
 Version 2.3.0
 ------
 

data/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing
+
+This documents includes guidelines for contributors.
+
+## Testing
+
+The project employs a diverse suite tests that help ensure it works as intended and prevents regressions as it continues to grow and evolve.
+
+### Unit Tests
+Most of the internal components the project uses have unit tests to thoroughly test them. Here dependencies of components are mocked or stubbed appropriately to ensure tests are reliable, test only one component and are fast!
+
+### Acceptance Tests
+
+Acceptance tests run the built `shopify` command line against a wide range of fixtures and verify its output and results. They are the slowest to run however provide the most coverage. The idea is to test a few complete scenarios for each major feature.
+
+Those are written in [Cucumber](https://cucumber.io/) and Ruby and can be found in the [`features/`](/features) directory. They can be executed by running
+
+```bash
+bundle exec cucumber
+bundle exec cucumber features/theme.feature:3 # A specific test
+```
+
+> **Note** that we currently don't have an approach for stubbing the interactions with the GraphQL APIs and that therefore we can't write acceptance tests for commands that interact with APIs.

data/Dockerfile

@@ -0,0 +1,19 @@
+# This is a Docker image to test the CLI in UNIX environments other than macOS
+# Build the image: docker build . -t shopify-cli
+# Run tests: docker run -t --rm --volume "$(pwd):/usr/src/app" shopify-cli bundle exec rake test
+FROM cimg/ruby:2.7.1-node
+
+RUN git config --global user.email "development-lifecycle@shopify.com"
+RUN git config --global user.name "Development Lifecycle"
+
+# throw errors if Gemfile has been modified since Gemfile.lock
+RUN bundle config --global frozen 1
+
+WORKDIR /usr/src/app
+
+COPY Gemfile Gemfile.lock ./
+COPY shopify-cli.gemspec  shopify-cli.gemspec
+COPY lib/shopify-cli/version.rb  lib/shopify-cli/version.rb
+COPY . .
+
+RUN bundle install

data/Gemfile

@@ -24,4 +24,5 @@ group :test do
   gem "webmock", require: false
   gem "timecop", require: false
   gem "rack", require: false
+  gem "cucumber", "~> 7.0", require: false
 end

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.3.0)
-      listen (~> 3.5)
-      theme-check (~> 1.2)
+    shopify-cli (2.4.0)
+      listen (~> 3.7.0)
+      theme-check (~> 1.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
     ast (2.4.2)
@@ -16,15 +16,50 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     crack (0.4.4)
+    cucumber (7.0.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 10.0, >= 10.0.1)
+      cucumber-create-meta (~> 6.0, >= 6.0.1)
+      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
+      cucumber-gherkin (~> 20.0, >= 20.0.1)
+      cucumber-html-formatter (~> 16.0, >= 16.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      cucumber-wire (~> 6.0, >= 6.0.1)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      mime-types (~> 3.3, >= 3.3.1)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-core (10.0.1)
+      cucumber-gherkin (~> 20.0, >= 20.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      cucumber-tag-expressions (~> 3.0, >= 3.0.1)
+    cucumber-create-meta (6.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-cucumber-expressions (12.1.3)
+    cucumber-gherkin (20.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    cucumber-html-formatter (16.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    cucumber-messages (17.1.0)
+    cucumber-tag-expressions (3.0.1)
+    cucumber-wire (6.1.1)
+      cucumber-core (~> 10.0, >= 10.0.1)
+      cucumber-cucumber-expressions (~> 12.1, >= 12.1.2)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    diff-lcs (1.4.4)
     fakefs (1.2.2)
     ffi (1.15.3)
     hashdiff (1.0.1)
     liquid (5.0.1)
-    listen (3.5.1)
+    listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     method_source (1.0.0)
-    mini_portile2 (2.5.3)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    mini_portile2 (2.6.1)
     minitest (5.14.2)
     minitest-fail-fast (0.1.0)
       minitest (~> 5)
@@ -34,11 +69,10 @@ GEM
       minitest (>= 5.0)
       ruby-progressbar
     mocha (1.11.2)
-    nokogiri (1.11.7)
-      mini_portile2 (~> 2.5.0)
+    multi_test (0.1.2)
+    nokogiri (1.12.4)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
-    nokogumbo (2.0.5)
-      nokogiri (~> 1.8, >= 1.8.4)
     parallel (1.20.1)
     parser (3.0.1.0)
       ast (~> 2.4.1)
@@ -76,9 +110,11 @@ GEM
     rubocop-shopify (2.0.1)
       rubocop (~> 1.11)
     ruby-progressbar (1.11.0)
-    theme-check (1.2.0)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    theme-check (1.4.0)
       liquid (>= 5.0.1)
-      nokogumbo
+      nokogiri (>= 1.12)
     timecop (0.9.2)
     unicode-display_width (2.0.0)
     webmock (3.9.3)
@@ -90,8 +126,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.1.4)
+  bundler (~> 2.2.2)
   byebug
+  cucumber (~> 7.0)
   fakefs (>= 1.0)
   minitest (>= 5.0.0)
   minitest-fail-fast

data/Rakefile

@@ -2,6 +2,7 @@ require_relative "bin/load_shopify"
 require "rake/testtask"
 require "rubocop/rake_task"
 require "bundler/gem_tasks"
+require "shellwords"
 
 Rake::TestTask.new do |t|
   t.libs += %w(test)
@@ -10,6 +11,33 @@ Rake::TestTask.new do |t|
   t.warning = false
 end
 
+desc "A set of tasks that run in Linux environments"
+namespace :linux do
+  desc "Runs the test suite in a Linux Docker environment"
+  task :test do
+    system("docker", "build", __dir__, "-t", "shopify-cli") || abort
+    system(
+      "docker", "run",
+      "-t", "--rm",
+      "--volume", "#{Shellwords.escape(__dir__)}:/usr/src/app",
+      "shopify-cli",
+      "bundle", "exec", "rake", "test"
+    ) || abort
+  end
+
+  desc "Runs the acceptance tests suite in a Linux Docker environment"
+  task :features do
+    system("docker", "build", __dir__, "-t", "shopify-cli") || abort
+    system(
+      "docker", "run",
+      "-t", "--rm",
+      "--volume", "#{Shellwords.escape(__dir__)}:/usr/src/app",
+      "shopify-cli",
+      "bundle", "exec", "cucumber"
+    ) || abort
+  end
+end
+
 RuboCop::RakeTask.new
 
 task(default: [:test, :rubocop])
@@ -98,3 +126,41 @@ end
 
 desc("Builds all distribution packages of the CLI")
 task(package: "package:all")
+
+namespace :extensions do
+  task :update do
+    version = ENV.fetch("VERSION").strip
+    error("Invalid version") unless /^v\d+\.\d+\.\d+/.match(version)
+    File.write(Paths.extension("version"), version)
+  end
+
+  task :symlink do
+    source = Paths.root("..", "shopify-cli-extensions", "shopify-extensions")
+    error("Unable to find shopify-extensions executable: #{executable}") unless File.executable?(source)
+    target = Paths.extension("shopify-extensions")
+    File.delete(target) if File.exist?(target)
+    File.symlink(source, target)
+  end
+
+  task :install do
+    target = Paths.extension("shopify-extensions")
+    require_relative Paths.extension("shopify_extensions.rb")
+    File.delete(target) if File.exist?(target)
+    ShopifyExtensions.install(target: target)
+  end
+
+  module Paths
+    def self.extension(*args)
+      root("ext", "shopify-extensions", *args)
+    end
+
+    def self.root(*args)
+      Pathname(File.dirname(__FILE__)).join(*args).to_s
+    end
+  end
+end
+
+def error(message, output: STDERR, code: 1)
+  output.puts(message)
+  exit(code)
+end

data/dev.yml

@@ -4,13 +4,19 @@ type:
 
 up:
   - ruby: 2.7.1
+  - homebrew:
+      - dpkg:
+          version: 1.20.9
+      - rpm:
+          version: 4.16.1.3
   - bundler
   - node:
       version: 14.9.0
       yarn: true
+  - docker
 
 test:
-  desc: 'Run tests.'
+  desc: "Run tests."
   run: |
     if [ "$#" -eq 1 ] && [[ -f $1 ]];
     then
@@ -18,3 +24,7 @@ test:
     else
       bundle exec rake test $@
     fi
+
+commands:
+  style:
+    run: bundle exec rubocop .

data/ext/shopify-extensions/extconf.rb

@@ -0,0 +1,21 @@
+require_relative "./shopify_extensions"
+
+installation_dir = ENV.fetch("SHOPIFY_CLI_EXTENSIONS_INSTALLATION_DIR", __dir__)
+
+File.write(File.expand_path("Makefile", installation_dir), <<~MAKEFILE)
+  .PHONY: clean
+
+  clean: ;
+
+  install: ;
+MAKEFILE
+
+begin
+  ShopifyExtensions.install(
+    target: File.expand_path("shopify-extensions", installation_dir)
+  )
+rescue ShopifyExtensions::InstallationError => error
+  STDERR.puts(error.message)
+rescue => error
+  STDERR.puts("Unable to install shopify-extensions: #{error}")
+end

data/ext/shopify-extensions/shopify_extensions.rb

@@ -0,0 +1,152 @@
+require "rbconfig"
+require "open-uri"
+require "zlib"
+require "open3"
+
+module ShopifyExtensions
+  def self.install(**args)
+    Install.call(**args)
+  end
+
+  class Install
+    def self.call(platform: Platform.new, **args)
+      new.call(platform: platform, **args)
+    end
+
+    def self.version
+      File.read(File.expand_path("../version", __FILE__)).strip
+    end
+
+    def call(platform:, version: self.class.version, target:)
+      target = platform.format_path(target.to_s)
+
+      asset = Asset.new(
+        platform: platform,
+        version: version,
+        owner: "Shopify",
+        repository: "shopify-cli-extensions",
+        basename: "shopify-extensions"
+      )
+      downloaded = asset.download(target: target)
+      raise InstallationError.asset_not_found(platform: platform, version: version) unless downloaded
+
+      raise InstallationError.installation_failed unless verify(target, version: version)
+    end
+
+    private
+
+    def fetch_release_details_for(version:)
+      JSON.parse(URI.parse(release_url_for(version: version)).open.read).yield_self(&Release)
+    rescue OpenURI::HTTPError
+      nil
+    end
+
+    def verify(target, version:)
+      return false unless File.executable?(target)
+      installed_server_version, exit_code = Open3.capture2(target, "version")
+      return false unless exit_code == 0
+      return false unless installed_server_version.strip == version.strip
+      true
+    end
+  end
+
+  class InstallationError < RuntimeError
+    def self.installation_failed
+      new("Failed to install shopify-extensions properly")
+    end
+
+    def self.asset_not_found(platform:, version:)
+      new(format(
+        "Unable to download shopify-extensions %{version} for %{os} (%{cpu})",
+        version: version,
+        os: platform.os,
+        cpu: platform.cpu
+      ))
+    end
+  end
+
+  Asset = Struct.new(:platform, :version, :owner, :repository, :basename, keyword_init: true) do
+    def download(target:)
+      Dir.chdir(File.dirname(target)) do
+        File.open(File.basename(target), "wb") do |target_file|
+          decompress(url.open, target_file)
+        end
+        File.chmod(0755, target)
+      end
+
+      true
+    rescue OpenURI::HTTPError
+      false
+    end
+
+    def url
+      URI.parse(format(
+        "https://github.com/%{owner}/%{repository}/releases/download/%{version}/%{filename}",
+        owner: owner,
+        repository: repository,
+        version: version,
+        filename: filename
+      ))
+    end
+
+    def filename
+      format(
+        "%{basename}-%{os}-%{cpu}.%{extension}",
+        basename: basename,
+        os: platform.os,
+        cpu: platform.cpu,
+        extension: platform.os == "windows" ? "exe.gz" : "gz"
+      )
+    end
+
+    private
+
+    def decompress(source, target)
+      zlib = Zlib::GzipReader.new(source)
+      target << zlib.read
+    ensure
+      zlib.close
+    end
+  end
+
+  Platform = Struct.new(:ruby_config) do
+    def initialize(ruby_config = RbConfig::CONFIG)
+      super(ruby_config)
+    end
+
+    def format_path(path)
+      case os
+      when "windows"
+        File.extname(path) != ".exe" ? path + ".exe" : path
+      else
+        path
+      end
+    end
+
+    def to_s
+      format("%{os}-%{cpu}", os: os, cpu: cpu)
+    end
+
+    def os
+      case ruby_config.fetch("host_os")
+      when /linux/
+        "linux"
+      when /darwin/
+        "darwin"
+      else
+        "windows"
+      end
+    end
+
+    def cpu
+      case ruby_config.fetch("host_cpu")
+      when /arm.*64/
+        "arm64"
+      when /64/
+        "amd64"
+      else
+        "386"
+      end
+    end
+  end
+end

data/ext/shopify-extensions/version

@@ -0,0 +1 @@
+v0.1.0

data/lib/project_types/extension/cli.rb

@@ -41,6 +41,7 @@ module Extension
     autoload :FindNpmPackages, Project.project_filepath("tasks/find_npm_packages")
     autoload :GetExtensions, Project.project_filepath("tasks/get_extensions")
     autoload :GetProduct, Project.project_filepath("tasks/get_product")
+    autoload :RunExtensionCommand, Project.project_filepath("tasks/run_extension_command")
 
     module Converters
       autoload :RegistrationConverter, Project.project_filepath("tasks/converters/registration_converter")
@@ -55,6 +56,7 @@ module Extension
     module Questions
       autoload :AskApp, Project.project_filepath("forms/questions/ask_app")
       autoload :AskName, Project.project_filepath("forms/questions/ask_name")
+      autoload :AskTemplate, Project.project_filepath("forms/questions/ask_template")
       autoload :AskType, Project.project_filepath("forms/questions/ask_type")
       autoload :AskRegistration, Project.project_filepath("forms/questions/ask_registration")
     end
@@ -87,6 +89,16 @@ module Extension
       autoload :Default, Project.project_filepath("models/specification_handlers/default")
     end
 
+    module ServerConfig
+      autoload :Base, Project.project_filepath("models/server_config/base")
+      autoload :Development, Project.project_filepath("models/server_config/development")
+      autoload :DevelopmentEntries, Project.project_filepath("models/server_config/development_entries")
+      autoload :DevelopmentRenderer, Project.project_filepath("models/server_config/development_renderer")
+      autoload :Extension, Project.project_filepath("models/server_config/extension")
+      autoload :Root, Project.project_filepath("models/server_config/root")
+      autoload :User, Project.project_filepath("models/server_config/user")
+    end
+
     autoload :App, Project.project_filepath("models/app")
     autoload :Registration, Project.project_filepath("models/registration")
     autoload :Version, Project.project_filepath("models/version")
@@ -96,6 +108,8 @@ module Extension
     autoload :LazySpecificationHandler, Project.project_filepath("models/lazy_specification_handler")
     autoload :NpmPackage, Project.project_filepath("models/npm_package")
     autoload :Product, Project.project_filepath("models/product")
+    autoload :DevelopmentServer, Project.project_filepath("models/development_server")
+    autoload :DevelopmentServerRequirements, Project.project_filepath("models/development_server_requirements")
   end
 
   autoload :ExtensionProjectKeys, Project.project_filepath("extension_project_keys")

data/lib/project_types/extension/commands/build.rb

@@ -12,6 +12,34 @@ module Extension
       NPM_BUILD_COMMAND = %w(run-script build)
 
       def call(_args, _command_name)
+        project = ExtensionProject.current(force_reload: true)
+        return run_new_flow(project) if supports_development_server?(project.specification_identifier)
+        run_legacy_flow
+      end
+
+      def self.help
+        ShopifyCli::Context.new.message("build.help", ShopifyCli::TOOL_NAME)
+      end
+
+      private
+
+      def run_new_flow(project)
+        Tasks::RunExtensionCommand.new(
+          type: project.specification_identifier.downcase,
+          command: "build"
+        ).call
+
+        @ctx.puts(@ctx.message("build.build_success_message"))
+      rescue => error
+        if error.message.include?("no such file or directory")
+          @ctx.abort(@ctx.message("build.directory_not_found"))
+        else
+          @ctx.debug(error)
+          @ctx.abort(@ctx.message("build.build_failure_message"))
+        end
+      end
+
+      def run_legacy_flow
         system = ShopifyCli::JsSystem.new(ctx: @ctx)
 
         CLI::UI::Frame.open(@ctx.message("build.frame_title", system.package_manager)) do
@@ -20,8 +48,8 @@ module Extension
         end
       end
 
-      def self.help
-        ShopifyCli::Context.new.message("build.help", ShopifyCli::TOOL_NAME)
+      def supports_development_server?(type)
+        Models::DevelopmentServerRequirements.supported?(type)
       end
     end
   end