Initial dotnet_sdk updater (#10756)

* Initial `dotnet_sdk` updater Closes #2442 * Apply suggestions from code review Co-authored-by: Martin Costello <[email protected]> * Document that we are consciously using semver for .NET SDK versioning * Use `File.basename` for comparison * Use `gsub` to update `global.json` instead of parsing JSON * implement `look_up_source` in `MetadataFinder` * regenerate `Gemfile.lock` * bump `file_updater` from `strict` to `strong` * Remove unnecessary comments * `bundle install` * Regnerate `Gemfile.lock` --------- Co-authored-by: Martin Costello <[email protected]> Co-authored-by: Hariharan Thavachelvam <[email protected]>
dependabot · Nov 1, 2024 · 0d9864e · 0d9864e
1 parent b760eb8
commit 0d9864e
Show file tree

Hide file tree

Showing 53 changed files with 16,085 additions and 4 deletions.
diff --git a/.github/ci-filters.yml b/.github/ci-filters.yml
@@ -23,6 +23,9 @@ devcontainers:
 docker:
   - *shared
   - 'docker/**'
+dotnet_sdk:
+  - *shared
+  - 'dotnet_sdk/**'
 elm:
   - *shared
   - 'elm/**'

diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -18,6 +18,10 @@
 - changed-files:
   - any-glob-to-any-file: docker/**
 
+"L: dotnet-sdk":
+- changed-files:
+  - any-glob-to-any-file: dotnet_sdk/**
+
 "L: elm":
 - changed-files:
   - any-glob-to-any-file: elm/**

diff --git a/.github/smoke-filters.yml b/.github/smoke-filters.yml
@@ -22,6 +22,9 @@ devcontainers:
 docker:
   - *common
   - 'docker/**'
+dotnet_sdk:
+  - *common
+  - 'dotnet_sdk/**'
 elm:
   - *common
   - 'elm/**'

diff --git a/.github/smoke-matrix.json b/.github/smoke-matrix.json
@@ -24,6 +24,11 @@
     "test": "docker",
     "ecosystem": "docker"
   },
+  {
+    "core": "dotnet_sdk",
+    "test": "dotnet-sdk",
+    "ecosystem": "dotnet-sdk"
+  },
   {
     "core": "elm",
     "test": "elm",

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,6 +20,7 @@ jobs:
           - { path: common, name: common, ecosystem: common}
           - { path: composer, name: composer, ecosystem: composer }
           - { path: docker, name: docker, ecosystem: docker }
+          - { path: dotnet_sdk, name: dotnet_sdk, ecosystem: dotnet-sdk }
           - { path: elm, name: elm, ecosystem: elm }
           - { path: git_submodules, name: git_submodules, ecosystem: gitsubmodule }
           - { path: github_actions, name: github_actions, ecosystem: github-actions }

diff --git a/.github/workflows/images-branch.yml b/.github/workflows/images-branch.yml
@@ -1,7 +1,7 @@
 name: Branch images
 env:
   GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-on:  # yamllint disable-line rule:truthy
+on: # yamllint disable-line rule:truthy
   pull_request:
     branches:
       - main
@@ -55,6 +55,7 @@ jobs:
           - { name: cargo, ecosystem: cargo }
           - { name: composer, ecosystem: composer }
           - { name: docker, ecosystem: docker }
+          - { name: dotnet_sdk, ecosystem: dotnet-sdk }
           - { name: elm, ecosystem: elm }
           - { name: git_submodules, ecosystem: gitsubmodule }
           - { name: github_actions, ecosystem: github-actions }

diff --git a/.github/workflows/images-latest.yml b/.github/workflows/images-latest.yml
@@ -37,6 +37,7 @@ jobs:
           - { name: cargo, ecosystem: cargo }
           - { name: composer, ecosystem: composer }
           - { name: docker, ecosystem: docker }
+          - { name: dotnet_sdk, ecosystem: dotnet-sdk }
           - { name: elm, ecosystem: elm }
           - { name: git_submodules, ecosystem: gitsubmodule }
           - { name: github_actions, ecosystem: github-actions }

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -7,9 +7,8 @@
       "request": "launch",
       "command": "rspec",
       "cwd": "${workspaceRoot}/${input:ecosystem}",
-      "useBundler": true,
       "script": "${file}",
-      "args": ["--tag", "focus"]
+      "rdbgPath": "bundle exec rdbg"
     },
     {
       "name": "Debug dry run",
@@ -85,6 +84,7 @@
         "composer",
         "dep",
         "docker",
+        "dotnet_sdk",
         "elm",
         "github_actions",
         "go_modules",
@@ -110,6 +110,7 @@
         "common",
         "composer",
         "docker",
+        "dotnet_sdk",
         "elm",
         "github_actions",
         "go_modules",

diff --git a/Dockerfile.updater-core b/Dockerfile.updater-core
@@ -87,6 +87,7 @@ COPY --chown=dependabot:dependabot cargo/.bundle cargo/dependabot-cargo.gemspec
 COPY --chown=dependabot:dependabot composer/.bundle composer/dependabot-composer.gemspec composer/
 COPY --chown=dependabot:dependabot devcontainers/.bundle devcontainers/dependabot-devcontainers.gemspec devcontainers/
 COPY --chown=dependabot:dependabot docker/.bundle docker/dependabot-docker.gemspec docker/
+COPY --chown=dependabot:dependabot dotnet_sdk/.bundle dotnet_sdk/dependabot-dotnet_sdk.gemspec dotnet_sdk/
 COPY --chown=dependabot:dependabot elm/.bundle elm/dependabot-elm.gemspec elm/
 COPY --chown=dependabot:dependabot git_submodules/.bundle git_submodules/dependabot-git_submodules.gemspec git_submodules/
 COPY --chown=dependabot:dependabot github_actions/.bundle github_actions/dependabot-github_actions.gemspec github_actions/
@@ -103,7 +104,7 @@ COPY --chown=dependabot:dependabot swift/.bundle swift/dependabot-swift.gemspec
 COPY --chown=dependabot:dependabot terraform/.bundle terraform/dependabot-terraform.gemspec terraform/
 
 # prevent having all the source in every ecosystem image
-RUN for ecosystem in git_submodules terraform github_actions hex elm docker nuget maven gradle cargo composer go_modules python pub npm_and_yarn bundler silent swift devcontainers; do \
+RUN for ecosystem in git_submodules terraform github_actions hex elm docker nuget maven gradle cargo composer go_modules python pub npm_and_yarn bundler silent swift devcontainers dotnet_sdk; do \
     mkdir -p $ecosystem/lib/dependabot; \
     touch $ecosystem/lib/dependabot/$ecosystem.rb; \
   done

diff --git a/Gemfile b/Gemfile
@@ -8,6 +8,7 @@ gem "dependabot-common", path: "common"
 gem "dependabot-composer", path: "composer"
 gem "dependabot-devcontainers", path: "devcontainers"
 gem "dependabot-docker", path: "docker"
+gem "dependabot-dotnet_sdk", path: "dotnet_sdk"
 gem "dependabot-elm", path: "elm"
 gem "dependabot-github_actions", path: "github_actions"
 gem "dependabot-git_submodules", path: "git_submodules"

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -53,6 +53,12 @@ PATH
     dependabot-docker (0.283.0)
       dependabot-common (= 0.283.0)
 
+PATH
+  remote: dotnet_sdk
+  specs:
+    dependabot-dotnet_sdk (0.283.0)
+      dependabot-common (= 0.283.0)
+
 PATH
   remote: elm
   specs:
@@ -377,6 +383,7 @@ DEPENDENCIES
   dependabot-composer!
   dependabot-devcontainers!
   dependabot-docker!
+  dependabot-dotnet_sdk!
   dependabot-elm!
   dependabot-git_submodules!
   dependabot-github_actions!

diff --git a/Rakefile b/Rakefile
@@ -34,6 +34,7 @@ GEMSPECS = %w(
   silent/dependabot-silent.gemspec
   swift/dependabot-swift.gemspec
   devcontainers/dependabot-devcontainers.gemspec
+  dotnet_sdk/dependabot-dotnet_sdk.gemspec
 ).freeze
 
 def run_command(command)

diff --git a/bin/docker-dev-shell b/bin/docker-dev-shell
@@ -152,6 +152,11 @@ docker run --rm -ti \
   -v "$(pwd)/docker/lib:$CODE_DIR/docker/lib" \
   -v "$(pwd)/docker/script:$CODE_DIR/docker/script" \
   -v "$(pwd)/docker/spec:$CODE_DIR/docker/spec" \
+  -v "$(pwd)/dotnet_sdk/.rubocop.yml:$CODE_DIR/dotnet_sdk/.rubocop.yml" \
+  -v "$(pwd)/dotnet_sdk/dependabot-dotnet_sdk.gemspec:$CODE_DIR/dotnet_sdk/dependabot-dotnet_sdk.gemspec" \
+  -v "$(pwd)/dotnet_sdk/lib:$CODE_DIR/dotnet_sdk/lib" \
+  -v "$(pwd)/dotnet_sdk/script:$CODE_DIR/dotnet_sdk/script" \
+  -v "$(pwd)/dotnet_sdk/spec:$CODE_DIR/dotnet_sdk/spec" \
   -v "$(pwd)/dry-run:$CODE_DIR/dry-run" \
   -v "$(pwd)/elm/.rubocop.yml:$CODE_DIR/elm/.rubocop.yml" \
   -v "$(pwd)/elm/dependabot-elm.gemspec:$CODE_DIR/elm/dependabot-elm.gemspec" \

diff --git a/bin/dry-run.rb b/bin/dry-run.rb
@@ -36,6 +36,7 @@
 # - pub
 # - swift
 # - devcontainers
+# - dotnet_sdk
 
 # rubocop:disable Style/GlobalVars
 
@@ -55,6 +56,7 @@
 $LOAD_PATH << "./composer/lib"
 $LOAD_PATH << "./devcontainers/lib"
 $LOAD_PATH << "./docker/lib"
+$LOAD_PATH << "./dotnet_sdk/lib"
 $LOAD_PATH << "./elm/lib"
 $LOAD_PATH << "./git_submodules/lib"
 $LOAD_PATH << "./github_actions/lib"
@@ -100,6 +102,7 @@
 require "dependabot/composer"
 require "dependabot/devcontainers"
 require "dependabot/docker"
+require "dependabot/dotnet_sdk"
 require "dependabot/elm"
 require "dependabot/git_submodules"
 require "dependabot/github_actions"

diff --git a/common/lib/dependabot/config/file.rb b/common/lib/dependabot/config/file.rb
@@ -63,6 +63,7 @@ def self.parse(config)
         "composer" => "composer",
         "devcontainer" => "devcontainers",
         "docker" => "docker",
+        "dotnet-sdk" => "dotnet_sdk",
         "elm" => "elm",
         "github-actions" => "github_actions",
         "gitsubmodule" => "submodules",

diff --git a/dotnet_sdk/.bundle/config b/dotnet_sdk/.bundle/config
@@ -0,0 +1 @@
+BUNDLE_GEMFILE: "../dependabot-updater/Gemfile"
diff --git a/dotnet_sdk/.gitignore b/dotnet_sdk/.gitignore
@@ -0,0 +1,5 @@
+/.bundle/
+!.bundle/config
+/.env
+/tmp
+/dependabot-*.gem
diff --git a/dotnet_sdk/.rubocop.yml b/dotnet_sdk/.rubocop.yml
@@ -0,0 +1,4 @@
+inherit_from: ../.rubocop.yml
+
+Sorbet/StrictSigil:
+  Enabled: true
diff --git a/dotnet_sdk/Dockerfile b/dotnet_sdk/Dockerfile
@@ -0,0 +1,7 @@
+FROM ghcr.io/dependabot/dependabot-updater-core
+
+USER dependabot
+
+COPY --chown=dependabot:dependabot dotnet_sdk $DEPENDABOT_HOME/dotnet_sdk
+COPY --chown=dependabot:dependabot common $DEPENDABOT_HOME/common
+COPY --chown=dependabot:dependabot updater $DEPENDABOT_HOME/dependabot-updater
diff --git a/dotnet_sdk/README.md b/dotnet_sdk/README.md
@@ -0,0 +1,18 @@
+## `dependabot-dotnet-sdk`
+
+.NET SDK support for [`dependabot-core`][core-repo].
+
+### Running locally
+
+1. Start a development shell
+
+  ```
+  $ bin/docker-dev-shell dotnet-sdk
+  ```
+
+2. Run tests
+   ```
+   [dependabot-core-dev] ~ $ cd dotnet-sdk && rspec
+   ```
+
+[core-repo]: https://github.com/dependabot/dependabot-core
diff --git a/dotnet_sdk/dependabot-dotnet_sdk.gemspec b/dotnet_sdk/dependabot-dotnet_sdk.gemspec
@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  common_gemspec =
+    Bundler.load_gemspec_uncached("../common/dependabot-common.gemspec")
+
+  spec.name         = "dependabot-dotnet_sdk"
+  spec.summary      = "Provides Dependabot support for .NET SDK"
+  spec.description  = "dependabot-dotnet_sdk provides support for managing .NET SDK versioning via Dependabot."
+
+  spec.author       = common_gemspec.author
+  spec.email        = common_gemspec.email
+  spec.homepage     = common_gemspec.homepage
+  spec.license      = common_gemspec.license
+
+  spec.metadata = {
+    "bug_tracker_uri" => common_gemspec.metadata["bug_tracker_uri"],
+    "changelog_uri" => common_gemspec.metadata["changelog_uri"]
+  }
+
+  spec.version = common_gemspec.version
+  spec.required_ruby_version = common_gemspec.required_ruby_version
+  spec.required_rubygems_version = common_gemspec.required_ruby_version
+
+  spec.require_path = "lib"
+  spec.files        = Dir["lib/**/*"]
+
+  spec.add_dependency "dependabot-common", Dependabot::VERSION
+
+  common_gemspec.development_dependencies.each do |dep|
+    spec.add_development_dependency dep.name, *dep.requirement.as_list
+  end
+end
diff --git a/dotnet_sdk/lib/dependabot/dotnet_sdk.rb b/dotnet_sdk/lib/dependabot/dotnet_sdk.rb
@@ -0,0 +1,20 @@
+# typed: strong
+# frozen_string_literal: true
+
+# These all need to be required so the various classes can be registered in a
+# lookup table of package manager names to concrete classes.
+require "dependabot/dotnet_sdk/file_fetcher"
+require "dependabot/dotnet_sdk/file_parser"
+require "dependabot/dotnet_sdk/update_checker"
+require "dependabot/dotnet_sdk/file_updater"
+require "dependabot/dotnet_sdk/metadata_finder"
+require "dependabot/dotnet_sdk/requirement"
+require "dependabot/dotnet_sdk/version"
+
+require "dependabot/pull_request_creator/labeler"
+Dependabot::PullRequestCreator::Labeler
+  .register_label_details("dotnet_sdk", name: "dotnet_sdk_package_manager", colour: "512BD4")
+
+require "dependabot/dependency"
+Dependabot::Dependency
+  .register_production_check("dotnet_sdk", ->(_) { true })
diff --git a/dotnet_sdk/lib/dependabot/dotnet_sdk/file_fetcher.rb b/dotnet_sdk/lib/dependabot/dotnet_sdk/file_fetcher.rb
@@ -0,0 +1,46 @@
+# typed: strong
+# frozen_string_literal: true
+
+require "dependabot/file_fetchers"
+require "dependabot/file_fetchers/base"
+require "sorbet-runtime"
+
+module Dependabot
+  module DotnetSdk
+    class FileFetcher < Dependabot::FileFetchers::Base
+      extend T::Sig
+
+      sig { override.params(filenames: T::Array[String]).returns(T::Boolean) }
+      def self.required_files_in?(filenames)
+        filenames.any? { |f| File.basename(f) == "global.json" }
+      end
+
+      sig { override.returns(String) }
+      def self.required_files_message
+        "Repo must contain a global.json file."
+      end
+
+      sig { override.returns(T::Array[Dependabot::DependencyFile]) }
+      def fetch_files
+        fetched_files = []
+        fetched_files << root_file
+
+        return fetched_files if fetched_files.any?
+
+        raise Dependabot::DependencyFileNotFound.new(
+          nil,
+          "global.json not found in #{directory}"
+        )
+      end
+
+      private
+
+      sig { returns(T.nilable(Dependabot::DependencyFile)) }
+      def root_file
+        fetch_file_if_present("global.json")
+      end
+    end
+  end
+end
+
+Dependabot::FileFetchers.register("dotnet_sdk", Dependabot::DotnetSdk::FileFetcher)