fb_bookworm 0.0.1

data/lib/bookworm/reports/RoleRecipeEntrypoints.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Determines all recipes that are directly referenced by all roles'
+needs_rules ['RoleRunListRecipes']
+
+def to_a
+  buffer = Set.new
+  @kb.roles.each do |_, metadata|
+    metadata['RoleRunListRecipes'].each do |recipe|
+      buffer << recipe
+    end
+  end
+  buffer.sort.to_a
+end
+
+def output
+  to_a
+end

data/lib/bookworm/reports/RoleReferencedRoles.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Determine roles which are directly referenced by other roles'
+needs_rules ['RoleExplicitRoles']
+
+def to_a
+  buffer = Set.new
+  @kb.roles.each do |_, metadata|
+    metadata['RoleExplicitRoles'].each do |role|
+      buffer << role
+    end
+  end
+  buffer.sort.to_a
+end
+
+def output
+  to_a
+end

data/lib/bookworm/rules/ExplicitMetadataDepends.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Extract depends usage from a cookbook\'s metadata.rb'
+keys ['metadatarb']
+
+def_node_search :explicit_depends, '`(send nil? :depends (str $_))'
+
+def to_a
+  explicit_depends(@metadata['ast']).to_a.uniq
+end

data/lib/bookworm/rules/IncludeRecipeDynamic.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Extracts recipes that do not use include_recipe with a string literal'
+keys ['recipe']
+
+def_node_search :include_recipe_dynamic, '`(send nil? :include_recipe $_)'
+
+def output
+  include_recipe_dynamic(@metadata['ast']).any? do |x|
+    !(x.is_a?(RuboCop::AST::StrNode) && x.str_type?)
+  end
+end

data/lib/bookworm/rules/IncludeRecipeLiterals.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Extracts recipes that are used by include_recipe with string literals'
+keys ['recipe']
+
+def_node_search :include_recipe_string_literals, '`(send nil? :include_recipe (str $_))'
+
+def to_a
+  arr = []
+  include_recipe_string_literals(@metadata['ast']).each do |x|
+    arr << x
+  end
+  return [] if arr.empty?
+  arr.map! do |x|
+    if x.start_with?('::')
+      "#{@metadata['cookbook']}#{x}"
+    elsif !x.include?('::')
+      "#{x}::default"
+    else
+      x
+    end
+  end
+  arr.uniq!
+  arr.sort!
+end

data/lib/bookworm/rules/LibraryDefinedClassConstants.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Get all class constants - it does *not* qualify the namespace'
+keys ['library']
+
+def_node_search :defined_class_constants, '`(class (const nil? $_) ...)'
+
+def to_a
+  defined_class_constants(@metadata['ast']).to_a.uniq
+end

data/lib/bookworm/rules/LibraryDefinedModuleConstants.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Get all module constants - it does *not* qualify the namespace'
+keys ['library']
+
+def_node_search :defined_module_constants, '`(module (const nil? $_) ...)'
+
+def to_a
+  defined_module_constants(@metadata['ast']).to_a.uniq
+end

data/lib/bookworm/rules/NoParsedRuby.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Ruby files which are empty, comments-only, ' +
+            'or unparseable by RuboCop'
+keys %w{
+  attribute
+  library
+  metadatarb
+  provider
+  recipe
+  resource
+  role
+}
+
+# See note in crawler.rb about EMPTY_RUBOCOP_AST constant
+def output
+  @metadata['ast'] == Bookworm::Crawler::EMPTY_RUBOCOP_AST
+end

data/lib/bookworm/rules/RecipeConstantAssignments.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Extract constants that are defined in recipes'
+keys ['recipe']
+
+def_node_search :constants_assigned, '`(casgn nil? $_ ...)'
+
+def to_a
+  constants_assigned(@metadata['ast']).to_a.uniq.sort
+end

data/lib/bookworm/rules/RoleDescription.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Scrapes description from role file'
+keys ['role']
+
+def_node_matcher :role_description, '`(send nil? :description (str $_))'
+
+def output
+  role_description @metadata['ast']
+end

data/lib/bookworm/rules/RoleExplicitRoles.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Scrapes explicit roles in a role files run list'
+keys ['role']
+
+def_node_matcher :role_run_list, '`(send nil? :run_list (str $_)*)'
+
+def output
+  arr = role_run_list @metadata['ast']
+  roles = []
+  arr&.each do |item|
+    roles << item if item.start_with? 'role['
+  end
+  # TODO(dcrosby) better regex here
+  roles.map! { |x| x.gsub(/^role\[/, '') }
+  roles.map { |x| x.gsub(/\]$/, '') }
+end

data/lib/bookworm/rules/RoleName.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Scrapes name from role file'
+keys ['role']
+
+def_node_matcher :role_name, '`(send nil? :name (str $_))'
+
+def output
+  role_name @metadata['ast']
+end

data/lib/bookworm/rules/RoleRunList.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Scrapes run list from role file'
+keys ['role']
+
+def_node_matcher :role_run_list, '`(send nil? :run_list (str $_)*)'
+
+def output
+  role_run_list @metadata['ast']
+end

data/lib/bookworm/rules/RoleRunListRecipes.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2022-present, Meta Platforms, Inc. and affiliates
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+description 'Scrapes run list recipes from role file'
+keys ['role']
+
+def_node_matcher :role_run_list, '`(send nil? :run_list (str $_)*)'
+
+def output
+  arr = role_run_list @metadata['ast']
+  recipes = []
+  arr&.each do |item|
+    recipes << item unless item.start_with? 'role['
+  end
+
+  recipes.map! { |x| x.start_with?('recipe[') ? x.match(/recipe\[(.*)\]/)[1] : x }
+  recipes.map { |x| x.include?('::') ? x : "#{x}::default" }
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: fb_bookworm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Crosby
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.25'
+description: Program to build context around Chef cookbook code
+email:
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/bookworm/configuration.rb
+- lib/bookworm/crawler.rb
+- lib/bookworm/exceptions.rb
+- lib/bookworm/infer_base_classes.rb
+- lib/bookworm/infer_engine.rb
+- lib/bookworm/keys.rb
+- lib/bookworm/knowledge_base.rb
+- lib/bookworm/load_hack.rb
+- lib/bookworm/report_builder.rb
+- lib/bookworm/reports/AllReferencedRecipes.rb
+- lib/bookworm/reports/AllRoleDescriptions.rb
+- lib/bookworm/reports/CookbookDependencyDot.rb
+- lib/bookworm/reports/DynamicRecipeInclusion.rb
+- lib/bookworm/reports/LeafCookbooks.rb
+- lib/bookworm/reports/LibraryDefinedModulesAndClassConstants.rb
+- lib/bookworm/reports/MissingReferencedRecipes.rb
+- lib/bookworm/reports/NoParsedRuby.rb
+- lib/bookworm/reports/NotReferencedRecipes.rb
+- lib/bookworm/reports/RecipesAssigningConstants.rb
+- lib/bookworm/reports/RoleRecipeEntrypoints.rb
+- lib/bookworm/reports/RoleReferencedRoles.rb
+- lib/bookworm/rules/ExplicitMetadataDepends.rb
+- lib/bookworm/rules/IncludeRecipeDynamic.rb
+- lib/bookworm/rules/IncludeRecipeLiterals.rb
+- lib/bookworm/rules/LibraryDefinedClassConstants.rb
+- lib/bookworm/rules/LibraryDefinedModuleConstants.rb
+- lib/bookworm/rules/NoParsedRuby.rb
+- lib/bookworm/rules/RecipeConstantAssignments.rb
+- lib/bookworm/rules/RoleDescription.rb
+- lib/bookworm/rules/RoleExplicitRoles.rb
+- lib/bookworm/rules/RoleName.rb
+- lib/bookworm/rules/RoleRunList.rb
+- lib/bookworm/rules/RoleRunListRecipes.rb
+homepage: https://github.com/facebook/bookworm
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: fb_bookworm
+test_files: []