Class: Dependabot::Opentofu::Package::PackageDetailsFetcher

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/dependabot/opentofu/package/package_details_fetcher.rb

Constant Summary collapse

RELEASES_URL_GIT = 
"https://api.github.com/repos/"
RELEASE_URL_FOR_PROVIDER = 
"https://api.opentofu.org/registry/docs/providers/"
RELEASE_URL_FOR_MODULE = 
"https://api.opentofu.org/registry/docs/modules/"
APPLICATION_JSON = 
"JSON"
ELIGIBLE_SOURCE_TYPES =

api.opentofu.org/registry/docs/providers/hashicorp/aws/index.json api.opentofu.org/registry/docs/modules/hashicorp/consul/aws/index.json

T.let(
  %w(git provider registry).freeze,
  T::Array[String]
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dependency:, credentials:, git_commit_checker:) ⇒ PackageDetailsFetcher

Returns a new instance of PackageDetailsFetcher.



36
37
38
39
40
 
# File 'lib/dependabot/opentofu/package/package_details_fetcher.rb', line 36

def initialize(dependency:, credentials:, git_commit_checker:)
  @dependency = dependency
  @credentials = credentials
  @git_commit_checker = git_commit_checker
end

Instance Attribute Details

#credentials ⇒ Object (readonly)

Returns the value of attribute credentials.



46
47
48
 
# File 'lib/dependabot/opentofu/package/package_details_fetcher.rb', line 46

def credentials
  @credentials
end

#git_commit_checker ⇒ Object (readonly)

Returns the value of attribute git_commit_checker.



43
44
45
 
# File 'lib/dependabot/opentofu/package/package_details_fetcher.rb', line 43

def git_commit_checker
  @git_commit_checker
end

Instance Method Details

#dependency_source_details ⇒ Object 



136
137
138
139
140
 
# File 'lib/dependabot/opentofu/package/package_details_fetcher.rb', line 136

def dependency_source_details
  return nil unless @dependency.source_details

  @dependency.source_details(allowed_types: ELIGIBLE_SOURCE_TYPES)
end

#fetch_tag_and_release_date ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/dependabot/opentofu/package/package_details_fetcher.rb', line 49

def fetch_tag_and_release_date
  truncate_github_url = @dependency.name.gsub("github.com/", "")
  url = RELEASES_URL_GIT + "#{truncate_github_url}/releases"
  result_lines = T.let([], T::Array[GitTagWithDetail])
  # Fetch the releases from the GitHub API
  response = Excon.get(
    url,
    headers: { "User-Agent" => "Dependabot (dependabot.com)",
               "Accept" => "application/vnd.github.v3+json" }
  )
  Dependabot.logger.error("Failed call details: #{response.body}") unless response.status == 200
  return result_lines unless response.status == 200

  # Parse the JSON response
  releases = JSON.parse(response.body)

  # Extract version names and release dates into a hash
  releases.map do |release|
    result_lines << GitTagWithDetail.new(
      tag: release["tag_name"],
      release_date: release["published_at"]
    )
  end

  # sort the result lines by tag in descending order
  result_lines = result_lines.sort_by(&:tag).reverse
  # Log the extracted details for debugging
  Dependabot.logger.info("Extracted release details: #{result_lines}")
  result_lines
end

#fetch_tag_and_release_date_from_module ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/dependabot/opentofu/package/package_details_fetcher.rb', line 110

def fetch_tag_and_release_date_from_module
  return [] unless dependency_source_details

  url = RELEASE_URL_FOR_MODULE + dependency_source_details&.fetch(:module_identifier) + "/index.json"
  Dependabot.logger.info("Fetching provider release details from URL: #{url}")
  result_lines = T.let([], T::Array[GitTagWithDetail])
  # Fetch the releases from the provider API
  response = Excon.get(url, headers: { "Accept" => "application/vnd.github.v3+json" })
  Dependabot.logger.error("Failed call details: #{response.body}") unless response.status == 200
  return result_lines unless response.status == 200

  # Parse the JSON response
  releases = JSON.parse(response.body).fetch("versions", [])

  # Extract version names and release dates into result_lines
  releases.each do |release|
    result_lines << GitTagWithDetail.new(
      tag: release["id"],
      release_date: release["published"]
    )
  end
  # Sort the result lines by tag in descending order
  result_lines.sort_by(&:tag).reverse
end

#fetch_tag_and_release_date_from_provider ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/dependabot/opentofu/package/package_details_fetcher.rb', line 81

def fetch_tag_and_release_date_from_provider
  return [] unless dependency_source_details

  url = RELEASE_URL_FOR_PROVIDER + dependency_source_details&.fetch(:module_identifier) + "/index.json"
  Dependabot.logger.info("Fetching provider release details from URL: #{url}")
  result_lines = T.let([], T::Array[GitTagWithDetail])
  # Fetch the releases from the provider API
  response = Excon.get(url, headers: { "Accept" => "application/vnd.github.v3+json" })
  Dependabot.logger.error("Failed call details: #{response.body}") unless response.status == 200
  return result_lines unless response.status == 200

  # Parse the JSON response
  releases = JSON.parse(response.body).fetch("versions", [])
  # Check if releases is an array and not empty
  return result_lines unless releases.is_a?(Array) && !releases.empty?

  # Extract version names and release dates into result_lines
  releases.each do |release|
    result_lines << GitTagWithDetail.new(
      tag: release["id"],
      release_date: release["published"]
    )
  end
  # Sort the result lines by tag in descending order
  result_lines.sort_by(&:tag).reverse
end