rule+report to cross-reference cookbook to maintainer

Summary:
A common problem is cross-referencing cookbooks to maintainers, this
rule to scrape out the cookbook name and the maintainer email makes this
process easy.

Differential Revision: D65182550

fbshipit-source-id: af538f7caa60c0b16e0f0e1f97aa83b2d2e28f3f

Author: dafyddcrosby

cookbooks/fb_bookworm/files/default/bookworm/reports/CookbookNameAndMaintainerEmail.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2022-present, Meta, Inc.
+# 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 'Cross-reference the cookbook name to the maintainer_email in a CSV fashion'
+needs_rules ['MetadatarbAttributeLiterals']
+
+def to_a
+  buffer = Set.new
+  @kb.metadatarbs.each do |_, metadata|
+    cb = metadata['MetadatarbAttributeLiterals']
+    buffer << "#{cb[:name]},#{cb[:maintainer_email]}"
+  end
+  buffer.sort.to_a
+end
+
+def output
+  to_a
+end

cookbooks/fb_bookworm/files/default/bookworm/rules/MetadatarbAttributeLiterals.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2022-present, Meta, Inc.
+# 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 metadata attribute string literals'
+keys ['metadatarb']
+
+# TODO Search *all* possible attributes
+
+def_node_search :attribute_literals, '`(send nil? ${:name :maintainer :maintainer_email} (str $_))'
+
+def output
+  attribute_literals(@metadata['ast'])&.to_h
+end

cookbooks/fb_bookworm/files/default/bookworm/spec/rules/MetadatarbAttributeLiterals_spec.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2022-present, Meta, Inc.
+# 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.
+require_relative './helper'
+
+describe Bookworm::InferRules::MetadatarbAttributeLiterals do
+  let(:ast) do
+    generate_ast(<<~RUBY)
+    name "fb_example"
+    maintainer "Dave"
+    maintainer_email "dave@example.org"
+  RUBY
+  end
+  it 'captures the metadata literals' do
+    rule = described_class.new({ 'ast' => ast })
+    expect(rule.output).to eq(
+      {
+        :name => 'fb_example',
+        :maintainer => 'Dave',
+        :maintainer_email => 'dave@example.org',
+      },
+                             )
+  end
+end