#!/usr/bin/env python3 # -*- coding: utf-8 -*- # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You 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. import os import sys sys.path.append(os.path.dirname(__file__)) from scriptutil import * import argparse import re from textwrap import dedent def update_build(file_path, search_re, replace_line): print('adding new module into %s' % file_path) matcher = re.compile(search_re) def edit(buffer, match, line): if replace_line in line: return None match = matcher.search(line) if match is not None: buffer.append(replace_line) buffer.append(line) return match is not None changed = update_file(file_path, matcher, edit) print('done' if changed else 'uptodate') def read_config(): parser = argparse.ArgumentParser(description='Scaffold new module into solr/modules/') parser.add_argument("name", help='short-name, e.g. my-module') parser.add_argument("full_name", help='Readable name, e.g. "My Module"') parser.add_argument("description", help='Short description for docs, max one line') newconf = parser.parse_args() return newconf def get_readme_skel(module_name): return dedent('''\ Apache Solr %s ===================================== Introduction ------------ TBD Getting Started --------------- TBD ''' % module_name) def get_license_header(): return dedent('''\ /* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You 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. */''') def get_build_gradle(description): return dedent('''\ apply plugin: 'java-library' description = '%s' dependencies { implementation project(':solr:core') testImplementation project(':solr:test-framework') }''' % description) def get_overview_tpl(name): return dedent('''\ Apache Solr Search Server: %s ''' % name) def scaffold_folder(module_name, module_full_name, module_folder, module_description): print("\nScaffolding folder %s" % module_folder) os.makedirs(module_folder) readme = os.path.join(module_folder, 'README.md') with open(readme, 'w') as fp: fp.write(get_readme_skel(module_full_name)) build = os.path.join(module_folder, 'build.gradle') with open(build, 'w') as fp: fp.write (get_license_header()) fp.write('\n\n') fp.write (get_build_gradle(module_description)) src_java_folder = os.path.join(module_folder, 'src', 'java') os.makedirs(src_java_folder) overview = os.path.join(src_java_folder, 'overview.html') with open(overview, 'w') as fp: fp.write (get_overview_tpl(module_full_name)) os.makedirs(os.path.join(module_folder, 'src', 'resources')) os.makedirs(os.path.join(module_folder, 'src', 'test-files')) os.makedirs(os.path.join(module_folder, 'src', 'test')) update_build(os.path.join('settings.gradle'), r'include "solr:modules:extraction"', 'include "solr:modules:%s"\n' % module_name) print("Adding new files to git") run("git add %s" % module_folder) def main(): conf = read_config() module_name = conf.name module_folder = os.path.join('solr', 'modules', module_name) scaffold_folder(module_name, conf.full_name, module_folder, conf.description) if __name__ == '__main__': try: main() except KeyboardInterrupt: print('\nReceived Ctrl-C, exiting early')