turbaszek commented on a change in pull request #11116: URL: https://github.com/apache/airflow/pull/11116#discussion_r494137849
########## File path: tests/upgrade/rules/test_fernet_enabled.py ########## @@ -0,0 +1,38 @@ +# 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. +from unittest import TestCase + +from airflow.upgrade.rules.fernet_enabled import FernetEnabledRule +from tests.test_utils.config import conf_vars + + +class TestFernetEnabledRule(TestCase): + + @conf_vars({("core", "fernet_key"): ""}) Review comment: Can you add test where the fernet key is not empty? Then there should be no message 👍 ########## File path: airflow/upgrade/rules/fernet_enabled.py ########## @@ -0,0 +1,38 @@ +# 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. + +from __future__ import absolute_import + +from airflow.configuration import conf +from airflow.upgrade.rules.base_rule import BaseRule + + +class FernetEnabledRule(BaseRule): + title = "Fernet is enabled by default" + + description = """ +The fernet mechanism is enabled by default to increase the security of the default installation. +""" + + def check(self): + fernet_key = conf.get("core", "fernet_key") + if not fernet_key: + return""" + fernet_key must be explicitly set empty as fernet mechanism is enabled by default Review comment: ```suggestion fernet_key in airflow.cfg must be explicitly set empty as fernet mechanism is enabled by default ``` Just to avoid any confusion ########## File path: airflow/upgrade/rules/fernet_enabled.py ########## @@ -0,0 +1,38 @@ +# 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. + +from __future__ import absolute_import + +from airflow.configuration import conf +from airflow.upgrade.rules.base_rule import BaseRule + + +class FernetEnabledRule(BaseRule): + title = "Fernet is enabled by default" + + description = """ +The fernet mechanism is enabled by default to increase the security of the default installation. Review comment: Let's avid the leading `\n` ########## File path: airflow/upgrade/rules/fernet_enabled.py ########## @@ -0,0 +1,38 @@ +# 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. + +from __future__ import absolute_import + +from airflow.configuration import conf +from airflow.upgrade.rules.base_rule import BaseRule + + +class FernetEnabledRule(BaseRule): + title = "Fernet is enabled by default" + + description = """ +The fernet mechanism is enabled by default to increase the security of the default installation. +""" + + def check(self): + fernet_key = conf.get("core", "fernet_key") + if not fernet_key: + return""" + fernet_key must be explicitly set empty as fernet mechanism is enabled by default Review comment: Same here we should avoid leading `\n` and the indentation otherwise looks strange: ``` Problems: 1. fernet_key must be explicitly set empty as fernet mechanism is enabled by default this means that the apache-airflow[crypto] extra-packages are always installed. However, this requires that your operating system has libffi-dev installed. ``` Using normal string would be enough ########## File path: airflow/upgrade/rules/fernet_enabled.py ########## @@ -0,0 +1,38 @@ +# 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. + +from __future__ import absolute_import + +from airflow.configuration import conf +from airflow.upgrade.rules.base_rule import BaseRule + + +class FernetEnabledRule(BaseRule): + title = "Fernet is enabled by default" + + description = ( + "The fernet mechanism is enabled by default " + + "to increase the security of the default installation." + ) + + def check(self): + fernet_key = conf.get("core", "fernet_key") + if not fernet_key: + return """fernet_key in airflow.cfg must be explicitly set empty as fernet mechanism is enabled by default + this means that the apache-airflow[crypto] extra-packages are always installed. + However, this requires that your operating system has libffi-dev installed. + """ Review comment: ```suggestion return "fernet_key in airflow.cfg must be explicitly set empty as fernet mechanism" \ " is enabled by default this means that the apache-airflow[crypto] extra-packages" \ " are always installed. However, this requires that your operating system has libffi-dev installed." ``` This should make the message one liner (it's important for json formatter). Currently it looks a bit unhealthy 😄 ![Uploading Screenshot 2020-09-24 at 17.38.28.png…]() ########## File path: airflow/upgrade/rules/fernet_enabled.py ########## @@ -0,0 +1,38 @@ +# 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. + +from __future__ import absolute_import + +from airflow.configuration import conf +from airflow.upgrade.rules.base_rule import BaseRule + + +class FernetEnabledRule(BaseRule): + title = "Fernet is enabled by default" + + description = ( + "The fernet mechanism is enabled by default " + + "to increase the security of the default installation." + ) Review comment: ```suggestion description = "The fernet mechanism is enabled by default " \ "to increase the security of the default installation." ``` ########## File path: airflow/upgrade/rules/fernet_enabled.py ########## @@ -0,0 +1,38 @@ +# 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. + +from __future__ import absolute_import + +from airflow.configuration import conf +from airflow.upgrade.rules.base_rule import BaseRule + + +class FernetEnabledRule(BaseRule): + title = "Fernet is enabled by default" + + description = ( + "The fernet mechanism is enabled by default " + + "to increase the security of the default installation." + ) Review comment: ```suggestion description = "The fernet mechanism is enabled by default " \ "to increase the security of the default installation." ``` ########## File path: airflow/upgrade/rules/fernet_enabled.py ########## @@ -0,0 +1,38 @@ +# 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. + +from __future__ import absolute_import + +from airflow.configuration import conf +from airflow.upgrade.rules.base_rule import BaseRule + + +class FernetEnabledRule(BaseRule): + title = "Fernet is enabled by default" + + description = ( + "The fernet mechanism is enabled by default " + + "to increase the security of the default installation." + ) + + def check(self): + fernet_key = conf.get("core", "fernet_key") + if not fernet_key: + return """fernet_key in airflow.cfg must be explicitly set empty as fernet mechanism is enabled by default + this means that the apache-airflow[crypto] extra-packages are always installed. + However, this requires that your operating system has libffi-dev installed. + """ Review comment: I personally just run black over the new rules 😉 ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
